Struct IdentityApi

pub struct IdentityApi<'a> { /* private fields */ }

Identity API operations

Implementations

impl<'a> IdentityApi<'a>

pub fn new(client: &'a VeracodeClient) -> Self

Create a new IdentityApi instance

pub async fn list_users( &self, query: Option<UserQuery>, ) -> Result<Vec<User>, IdentityError>

List users with optional filtering

Arguments

• query - Optional query parameters for filtering users

Returns

A Result containing a list of users or an error

pub async fn get_user(&self, user_id: &str) -> Result<User, IdentityError>

Get a specific user by ID

Arguments

• user_id - The ID of the user to retrieve

Returns

A Result containing the user or an error

pub async fn create_user( &self, request: CreateUserRequest, ) -> Result<User, IdentityError>

Create a new user

Arguments

• request - The user creation request

Returns

A Result containing the created user or an error

pub async fn update_user( &self, user_id: &str, request: UpdateUserRequest, ) -> Result<User, IdentityError>

Update an existing user

Arguments

• user_id - The ID of the user to update
• request - The user update request

Returns

A Result containing the updated user or an error

pub async fn delete_user(&self, user_id: &str) -> Result<(), IdentityError>

Delete a user

Arguments

• user_id - The ID of the user to delete

Returns

A Result indicating success or failure

pub async fn list_roles(&self) -> Result<Vec<Role>, IdentityError>

List all roles

Returns

A Result containing a list of roles or an error

pub async fn list_teams(&self) -> Result<Vec<Team>, IdentityError>

List all teams with pagination support

Returns

A Result containing a list of all teams across all pages or an error

pub async fn create_team( &self, request: CreateTeamRequest, ) -> Result<Team, IdentityError>

Create a new team

Arguments

• request - The team creation request

Returns

A Result containing the created team or an error

pub async fn delete_team(&self, team_id: &str) -> Result<(), IdentityError>

Delete a team

Arguments

• team_id - The ID of the team to delete

Returns

A Result indicating success or failure

pub async fn create_api_credentials( &self, request: CreateApiCredentialRequest, ) -> Result<ApiCredential, IdentityError>

Create API credentials

Arguments

• request - The API credential creation request

Returns

A Result containing the created API credentials or an error

pub async fn revoke_api_credentials( &self, api_creds_id: &str, ) -> Result<(), IdentityError>

Revoke API credentials

Arguments

• api_creds_id - The ID of the API credentials to revoke

Returns

A Result indicating success or failure

impl<'a> IdentityApi<'a>

Convenience methods for common operations

pub async fn find_user_by_email( &self, email: &str, ) -> Result<Option<User>, IdentityError>

Find a user by email address

Arguments

• email - The email address to search for

Returns

A Result containing the user if found, or None if not found

pub async fn find_user_by_username( &self, username: &str, ) -> Result<Option<User>, IdentityError>

Find a user by username

Arguments

• username - The username to search for

Returns

A Result containing the user if found, or None if not found

pub async fn create_simple_user( &self, email: &str, username: &str, first_name: &str, last_name: &str, team_ids: Vec<String>, ) -> Result<User, IdentityError>

Create a simple user with basic information

Arguments

• email - User’s email address
• username - User’s username
• first_name - User’s first name
• last_name - User’s last name
• team_ids - List of team IDs to assign (at least one required)

Returns

A Result containing the created user or an error

pub async fn create_api_service_account( &self, email: &str, username: &str, first_name: &str, last_name: &str, role_ids: Vec<String>, team_ids: Option<Vec<String>>, ) -> Result<User, IdentityError>

Create an API service account

Arguments

• email - Service account email address
• username - Service account username
• first_name - Service account first name
• last_name - Service account last name
• role_ids - List of role IDs to assign
• team_ids - Optional list of team IDs to assign

Returns

A Result containing the created user or an error