Skip to main content

Iam Api User v1 Service

Skip The Details?​

SDK and Documentation Under Construction 🚧

This warning will be removed once complete and ready for use.

Overview​

ApiUserService manages API user lifecycle and authentication credentials.

API users represent automated clients that can authenticate with API keys and perform operations within a specific group context. Each API user has:

  • A unique identifier and display name
  • Group ownership for resource isolation
  • Role-based permissions for authorization
  • Active/inactive state for access control

All operations require IAM domain permissions and operate within the authenticated group context.

Add your custom documentation for the Iam Api User v1 service here. This file is generated once and can be manually edited to provide service-specific information, examples, and usage guidance.

Quick Start​

  1. Configure your client with the appropriate credentials
  2. Choose your operations from the available service methods
  3. Review the types to understand request/response structures

Service Methods​

User Lifecycle Management​

CreateApiUser​

Creates a new API user with specified configuration within the authenticated group context. The system generates a unique identifier and API key for authentication. Use this to provision new automated clients that need programmatic access to the platform.

GetApiUser​

Retrieves a single API user by its unique identifier. Use this to view API user details, including current roles, state, and authentication information.

GetApiUserByKeyHash​

Retrieves an API user using its API key hash. This method is primarily used in authentication flows to lookup an API user based on the hash of their API key.

ListApiUsers​

Lists all API users in the authenticated group context, regardless of their active/inactive state. Use this for inventory management and auditing of automated clients.

SearchApiUsers​

Searches API users using display name substring filtering within the authenticated group context. Useful for finding specific API users when the exact identifier is not known.

State Management​

ActivateApiUser​

Activates an API user, enabling API key authentication. Use this to restore access for previously deactivated API users or to enable newly created users.

DeactivateApiUser​

Deactivates an API user, disabling API key authentication. Use this to temporarily or permanently revoke access without deleting the API user record, preserving audit trails.

Role Management​

AssignRoleToAPIUser​

Assigns a role to an existing API user within the authenticated group context. The role assignment enables the API user to perform operations according to the permissions associated with that role. Use this to grant new capabilities to an API user.

RevokeRoleFromAPIUser​

Revokes a role from an existing API user within the authenticated group context. The role revocation removes the permissions associated with that role from the API user. Use this to restrict API user capabilities or implement principle of least privilege.

Authentication & Authorization​

This service requires appropriate role-based permissions. See the individual method documentation for specific role requirements.