Jump to Content
Home
Use Cases
Concepts
Config Guides
Developer Guides
API Reference
Home
Content
Recipes
API Reference
Changelog
Discussions
Home
Use Cases
Concepts
Config Guides
Developer Guides
API Reference
Log In
API Reference
Log In
Home
Content
Recipes
API Reference
Changelog
Discussions
Create a STS client
Search
JUMP TO
OAuth and OIDC
OpenID Connect
Get provider's metadata.
get
Authorize the user to use OIDC.
get
Authorize the user to use OIDC.
post
Create a dynamic client.
post
Read a dynamic client.
get
Delete a dynamic client.
del
Authorize device to use OIDC.
post
Introspect the token.
post
Get the provider's JSON Web Key Set (JWKS).
get
Revoke the token.
post
Get the access token.
post
Retrieve user information
get
Retrieve user information
post
OpenID Connect API v2
Get provider's metadata
get
Authorize the user to use OIDC.
get
Authorize the user to use OIDC.
post
Get the access token.
post
Pushed Authorization Requests (PAR).
post
Authorize device to use OIDC.
post
Introspect the token
post
Retrieve user information
get
Retrieve user information
post
Revoke the token.
post
Create a dynamic client.
post
Read a dynamic client.
get
Delete a dynamic client.
del
Update a dynamic client.
put
Terminate user session at authorization server.
get
Terminate user session at authorization server.
post
Get the provider's signer certificates JSON Web Key Set (JWKS).
get
Get the provider's personal certificates JSON Web Key Set (JWKS).
get
Users & Groups
Account expiration configuration
Retrieve the global configuration for attribute mapping that can be overridden in individual identity providers.
get
Set the account expiration config.
put
Password Policy Management 2.0
Deprecated - Get the password policy for a specified tenant.
get
Deprecated - Update the password policy for a specified tenant.
put
Users Management Version 2.0
The bulk request that clients use to send a potentially large collection of resource operations in a single request. For a PUT, PATCH, or POST, the data in the operation is the resource data as for a single SCIM request.
post
Delete users for the specified tenant from a (CSV) file.
post
Get the list of supported header names.
get
Import users for the specified tenant from a comma separated value (CSV) file.
post
Retrieves a list of CSV import requests that belong to the specified tenant.
get
Retrieves the details of a CSV import request that belong to the specified tenant.
get
Cancels a CSV import request for the specified tenant.
put
Deletes a CSV import request from the specified tenant.
del
Retrieves the account details of the authenticated user in Cloud Directory.
get
Replaces the authenticated user's attributes in Cloud Directory.
put
Delete the authenticated user's Cloud Directory account.
del
Retrieves the authenticated user's effective password policy.
get
Retrieves the authenticated user's translated labels for their effective password policy.
get
Change the authenticated user's password.
post
Retrieves a list of a manager's reportees that belong to a specified tenant and match the search filter criteria.
get
Retrieves the SCIM capabilities enabled for the tenant.
get
Retrieves a list of users that belong to a specified tenant and match the search filter criteria.
get
Creates a user in Cloud Directory.
post
Authenticate a user name and password.
post
Retrieves the total number of users under a tenant in the Cloud Directory.
get
Retrieves the details of a user in Cloud Directory for a tenant.
get
Replaces the user's attributes in Cloud Directory.
put
Deletes a user from a specified tenant in Cloud Directory.
del
Modify a user's attributes in Cloud Directory. It can be used to update one or more attributes.
patch
Compare a clear text value to a custom hashed attribute value for a user.
post
Reset a user's password.
patch
Groups Management Version 2.0
Import groups for the specified tenant from a comma separated value (CSV) file.
post
Retrieves a list of groups that belong to the specified tenant and match the search criteria.
get
Creates a group for a specified tenant.
post
Retrieves the total number of groups under a tenant in the Cloud Directory.
get
Retrieves the details of a group for a specified tenant.
get
Updates the group's attributes for a specified tenant.
put
Delete a group from a specified tenant.
del
This API is used to modify a group's attributes. It can be used to update one or more attributes.
patch
User Self Care API
Initiate a reset password request by using an authentication mechanism.
post
Reset the user's forgotten password.
put
Validates the authentication attempt that is associated with the current step in the reset password flow.
post
List all invitations.
get
Send users an invitation.
post
Retrieve an invitation.
get
Complete a user invitation.
put
Cancel an invitation.
del
Validate a user invitation.
post
Initiate a forgot username request by using an authentication mechanism.
post
Recover the user's forgotten user name.
put
Validates the authentication attempt that is associated with the current step in the username recovery flow.
post
Attribute management
Attributes
Retrieves the list of attribute functions that are configured for the specified tenant
get
Lists all attributes
get
Creates an attribute
post
Bulk management operations of attributes
patch
Gets the list of existing attribute tags
get
Gets an attribute
get
Modifies an attribute
put
Deletes an attribute
del
Modifies selected properties of an attribute
patch
Reverts a global attribute to the default configuration
put
Application management
Application Access
Gets the list of all the operations that are performed on accounts of this tenant.
get
Retry a list of failed operations.
post
Gets details of the specified operation
get
Retry a failed operation
post
Gets the list of all applications that were onboarded by tenant administrator. A maximum of 500 applications are returned. Use pagination to fetch the next set of applications.
get
Creates an instance of an application for a tenant.
post
Checks if the identity source is configured with an application.
get
Create custom rule.
post
Get rule definition.
get
Update custom rule.
put
Gets the summary stats of all applications for a given tenant.
get
Gets the details of an application.
get
Updates an application.
put
Deletes the application that is specified by the application ID.
del
Gets the list of accounts for the specified application.
get
Remediate Non-Compliant accounts for an application.
post
Get the account attributes of given account associated with an application.
get
Get attribute values delta for an account for the application.
get
Suspend/Restore/Unmanage/deprovision an Account identified by this applicationId, userId.
post
Start / Stop Account Synchronization.
post
Get Last run reconciliation status for an application.
get
Gets adoption stats details of account synchronization for an application.
get
Stop given account synchronization of an application.
post
Gets the Application account list details for specified account synchronization id.
get
Retrieves all supporting data for a given application.
get
Provides mechanism to adopt an Orphan account
post
Retrieves a list of application ids that have the specified auth policy id attached.
get
Searches for the applications of an owner.
get
Fetches the details of an application accessible to owner.
get
Updates the attributes of an application accessible to the owner.
put
Fetches the entitlements of an application.
get
Updates entitlements to an application.
post
Get All account synchronization status for all applications of given tenant.
get
Gets all operations performed in an Account Sync operation
get
Fetches the applications that are entitled to a user.
get
API to determine if a user is entitled to an application.
post
Entitlement Management
Get the rights values associated to an assignment.
get
Update the rights values of an assignment.
patch
Creates a new entitlement.
post
Get the entitlements granted to a dynamic group.
get
Search the assignments.
post
Grant or revoke one or more entitlements to a group.
post
Review user added to or removed from application dynamic role.
post
Grant or revoke one or more entitlements to a dynamic group.
post
Search the entitlements.
post
Grant or revoke one or more entitlements to a user.
post
Get the entitlement details.
get
Grant or revoke an entitlement to one or more users and groups.
post
Delete an entitlement.
del
Update an entitlement.
patch
Find the children of an entitlement.
get
Add or remove one or more children for an entitlement.
post
Update the rights values of a role.
patch
Publish or discard an entitlement.
patch
Get the entitlements granted to a group.
get
Get the entitlements granted to the logged in user.
get
Check if a user is granted to an application.
get
Check if a user is granted to an application.
post
Get all the applications that are granted to a user.
get
Get the entitlements that are granted to a user.
get
Get the right values of a permission assigned to a user.
get
Authentication
Identity Source Types
Retrieve the details of all the identity source types.
get
Retrieve the details of a particular identity source types.
get
Retrieve the metadata of a particular SAML Enterprise.
get
Authentication Token Exchange
Exchange a valid bearer token for an authenticated browser session
get
Exchange a valid bearer token for an authenticated browser session
post
Authentication Manage User Sessions
Delete random session for the user.
del
Get the sessions for the user.
get
Revoke all sessions for the user.
del
Revoke or take some other action on specific sessions for the user ID that is specified in the request path.
patch
Social JWT Exchange
Exchange a valid social JWT for an IBM Security Verify access token.
post
FIDO Configuration
Retrieve the list of metadata entries.
get
Retrieve the list of metadata service entries.
get
Create a metadata entry.
post
Create a metadata service entry.
post
Retrieve a metadata entry.
get
Retrieve a metadata service entry.
get
Update a metadata entry.
put
Update a metadata service entry.
put
Delete a metadata entry.
del
Delete a metadata service entry.
del
Retrieve the list of relying party configurations.
get
Create a relying party configuration.
post
Retrieve a relying party configuration.
get
Update a relying party configuration.
put
Delete a relying party configuration.
del
QR Code Login Configuration
Retrieve the QR code login configuration.
get
Update the QR code login configuration.
put
reCAPTCHA
Retrieve the list of reCAPTCHA configurations
get
Create a reCAPTCHA configuration
post
Retrieve a reCAPTCHA configuration
get
Update a reCAPTCHA configuration
put
Delete a reCAPTCHA configuration
del
FIDO
Retrieve the list of FIDO registrations.
get
Retrieve a FIDO registration.
get
Update a FIDO registration.
put
Delete a FIDO registration.
del
Resolve an rpId.
post
Initiate a FIDO authentication.
post
Complete a FIDO authentication.
post
Initiate a FIDO registration.
post
Complete a FIDO registration.
post
QR Code Login
Create a QR code login verification.
get
Retrieve a QR code login verification.
get
Attempt a QR code login verification.
post
Cancel a QR code login verification.
del
Password Authentication
Retrieve the list of valid password based identity sources.
get
Change a user's password for an on-premise identity source.
put
Attempt password authentication with an identity source.
post
Reset a user's password for an on-premise identity source.
post
Multi-factor authentication
Authentication Factors 2.0
Retrieve the list of authentication factor enrollments.
get
Discover the availability of all authentication factors.
get
Discover the availability of an authentication factor.
get
Email One-time Password 2.0
Retrieve the list of email one-time password enrollments.
get
Create a email one-time password enrollment.
post
Create a transient email one-time password verification.
post
Retrieve a transient email one-time password verification.
get
Attempt a transient email one-time password verification.
post
Cancel a transient email one-time password verification.
del
Retrieve a email one-time password enrollment.
get
Update a email one-time password enrollment.
put
Delete a email one-time password enrollment.
del
Create a email one-time password verification.
post
Retrieve a email one-time password verification.
get
Attempt a email one-time password verification.
post
Cancel a email one-time password verification.
del
One-time Password
Create a one-time password verification.
post
Retrieve a one-time password verification.
get
Attempt a one-time password verification.
post
Cancel a one-time password verification.
del
Knowledge Questions
Retrieve the list of knowledge question enrollments.
get
Create a knowledge question enrollment.
post
Retrieve a knowledge question enrollment.
get
Update a knowledge question enrollment.
put
Delete a knowledge question enrollment.
del
Create a knowledge question verification.
post
Retrieve a knowledge question verification.
get
Attempt a knowledge question verification.
post
Delete a knowledge question verification.
del
SMS One-time Password 2.0
Retrieve the list of SMS one-time password enrollments.
get
Create a SMS one-time password enrollment.
post
Create a transient SMS one-time password verification.
post
Retrieve a transient SMS one-time password verification.
get
Attempt a transient SMS one-time password verification.
post
Cancel a transient SMS one-time password verification.
del
Retrieve a SMS one-time password enrollment.
get
Update a SMS one-time password enrollment.
put
Delete a SMS one-time password enrollment.
del
Create a SMS one-time password verification.
post
Retrieve a SMS one-time password verification.
get
Attempt a SMS one-time password verification.
post
Cancel a SMS one-time password verification.
del
Time-based One-time Password 2.0
Retrieve the list of time-based one-time password enrollments.
get
Create a time-based one-time password enrollment.
post
Retrieve a time-based one-time password enrollment.
get
Update a time-based one-time password enrollment.
put
Attempt a time-based one-time password verification.
post
Delete a time-based one-time password enrollment.
del
Voice One-time Password
Retrieve the list of voice one-time password enrollments.
get
Create a voice one-time password enrollment.
post
Create a transient voice one-time password verification.
post
Retrieve a transient voice one-time password verification.
get
Attempt a transient voice one-time password verification.
post
Cancel a transient voice one-time password verification.
del
Retrieve a voice one-time password enrollment.
get
Update a voice one-time password enrollment.
put
Delete a voice one-time password enrollment.
del
Create a voice one-time password verification.
post
Retrieve a voice one-time password verification.
get
Attempt a voice one-time password verification.
post
Cancel a voice one-time password verification.
del
Authenticators
Retrieve the list of registered authenticators.
get
Retrieve the list of available authenticator clients.
get
Initiate an authenticator registration.
post
Complete or refresh an authenticator registration.
post
Retrieve a specific authenticator registration.
get
Update the editable attributes of a specific authenticator registration.
put
Delete a specific authenticator registration.
del
Update the editable attributes of a specific authenticator registration.
patch
Retrieve the list of verification transactions.
get
Initiate a verification transaction.
post
Retrieve a specific verification transaction.
get
Complete a specific verification transaction.
post
Signature Authentication
Retrieve the list of signature enrollments.
get
Enroll a signature authentication method.
post
Retrieve a specific signature enrollment.
get
Update the editable attributes of a specific signature enrollment.
put
Delete a specific signature enrollment.
del
Update the editable attributes of a specific signature enrollment.
patch
Federation
Identity Provider Attribute Mappings
Retrieve the global configuration for attribute mapping that can be overridden in individual identity providers.
get
Set the global attribute mappings for identity sources.
put
OpenID Connect Grant Management
Deprecated - Retrieves the list of OIDC grants.
get
Deprecated - Bulk delete, disable, or enable OIDC grants.
patch
Deprecated - Retrieves a specific OIDC grant.
get
Deprecated - Deletes a specific OIDC grant.
del
Retrieves the list of OIDC grants.
get
Bulk delete, disable, or enable OIDC grants.
patch
Retrieves a specific OIDC grant.
get
Deletes a specific OIDC grant.
del
Retrieves the list of OIDC grants.
get
Bulk delete, disable, or enable OIDC grants.
patch
Retrieves a specific OIDC grant.
get
Deletes a specific OIDC grant.
del
Retrieves the list of OIDC application grants.
get
Bulk delete, disable, or enable OIDC application grants.
patch
Retrieves a specific OIDC application grant.
get
Deletes a specific OIDC application grant.
del
OpenID Connect Dynamic Client Profile
Read dynamic client profile.
get
Update dynamic client profile.
put
OpenID Connect Federation
Retrieves the OpenID Connect federation configuration.
get
Updates the OpenID Connect federation configuration.
put
SAML 2.0 Alias Management
Retrieves the list of aliases
get
Retrieves a specific alias
get
Deletes a specific alias
del
Retrieves the list of aliases belonging to user
get
Retrieves a specific alias belonging to user
get
Deletes a specific alias belonging to user
del
SAML 2.0 Federations Management
Get all Federations
get
Get a Federation
get
Update a Federation
put
Exports a federation metadata
get
WS Federation Management
Enable WS-Federation audit trace for the tenant
post
Enable WS-Federation audit trace
post
Access & Risk Policies
Access Policy Management V5.0
retrieve access policies
get
create an access policy
post
retrieve a access policy
get
update a access policy
put
create an access policy revision
post
delete an access policy
del
retrieve the revisions for an access policy
get
retrieve a revision for an access policy
get
update a access policy revision
put
delete an access policy revision
del
Branding & customization
Template File Registration
Get template registrations.
get
Register a template.
post
Delete a registered template file.
del
Customization - Themes
Reset customizations
del
List all the themes
get
Register a new theme
post
Download theme-based templates
get
Update a theme registration
put
Delete a theme registration
del
Download a specific template file from a theme
get
Update a specific template file for a theme
put
Deletes a customization for a specific template file in a theme
del
Lifecycle & Governance
Adapter Management
Get all custom profiles in system.
get
Create draft in system.
post
List all profiles using the attribute.
get
Get details of the specified profile
get
Update draft in system.
put
Delete specified profile
del
Get all profiles in system for a tenant with a given template id.
get
Get webui template in the system for a given profile id and template id.
get
Publish the profile
post
Upload the identity adapter profile JAR file.
post
Update the identity adapter profile.
put
Provisioning Management
Get provisioning policy for an application.
get
Update provisioning policy for an application. In addition resends all events for the application.
put
Create a provisioning policy for an applicatication. Provisioning policy enables or disables publishing of provisioning events for the application.
post
Delete provisioning policy for an application.
del
Access Request Management V1.0
Get details of specified requestable access.
get
Get the requestable access list for self.
post
Delete a request by id
del
Delete all the requests that are filtered by one or more query parameters.
del
Search requests of an approver
get
Get statistical view of requests for approval
get
Get statistical summary of requests for approval
get
Execute actions for a list of requests
post
Search the requests
get
Create a request
post
Get statistical view of requests
get
Get the summary of request statistics
get
Get request details
get
Add a justification
post
Send a reminder to all approvers of a request
post
Create a fine grained access requests
post
Cancel a list of requests
post
Deprecated - Search the self requests
get
Create a self request
post
Deprecated - Get statistical view of self requests
get
Deprecated - Get the summary of self request statistics
get
Deprecated - Create a fine grained access request for self
post
Deprecated - Cancel a list of requests
post
Find all requestable applications in the catalog.
get
Find a workflow configuration.
get
Create a workflow configuration.
post
Find a workflow configuration by ID.
get
Replace an existing workflow configuration.
put
Delete a workflow configuration.
del
Identity agents
Agent Bridge Support Service
Retrieve agent configurations.
get
Create an agent configuration.
post
Retrieve corrupted agent configuration(s) which can't be decrypted due to missing certificate
get
Retrieve a specific agent's configuration.
get
Update a specific agent configuration.
put
Delete an agent configuration.
del
Retrieve the API Client credentials.
get
Modify the API Client credential and configuration.
put
Data privacy & consent
Data Privacy and Consent Management
Patch a purpose relationship
patch
Retrieve all purposes
get
Create a new purpose
post
Retrieve a specific purpose
get
Create a new version of an existing purpose
put
Delete a specific purpose
del
Retrieve a specific purpose with version
get
Update an existing purpose and it's version
put
Delete a specific purpose with version
del
Update the state of an existing purpose
patch
Attach a document to a EULA
post
Retrieve all locale documents attached to the specified EULA version
get
Retrieve the EULA document for the specified locale
get
Delete the EULA document for the specified locale
del
Retrieve the EULA document for the specified locale
get
Retrieve the policy record.
get
Update the policy record.
put
Retrieve a list of consent records.
get
Bulk delete consent records.
patch
Retrieve a specific consent record.
get
Delete a specific consent record from a tenant.
del
Retrieve all access types
get
Create a new access type
post
Retrieve a specific access type
get
Update a specific access type
put
Delete a specific access type
del
Search a geography record by a search term.
get
Retrieve all the privacy rules in a tenant.
get
Create a privacy rule in a tenant.
post
Retrieve a specific privacy rule in a tenant.
get
Update a privacy rule in a tenant.
put
Delete a privacy rule in a tenant.
del
Retrieve a list of Privacy Profiles.
get
Create a Privacy Profile.
post
Retrieve a Privacy Profile by Id.
get
Update a Privacy Profile.
put
Delete a Privacy Profile by Id.
del
Retrieve all consent providers
get
Create a new consent provider
post
Retrieve a specific consent provider
get
Update a specific consent provider
put
Delete an existing consent provider
del
Data Privacy and Consent
Create or update a consent record.
post
Bulk create or patch consent records.
patch
Presents the data subject information to the user.
post
Provides the data usage approval.
post
Event analytics & reports
Events
Get all events for a tenant.
get
Reports
Generates a report asynchronously for a specified tenant into a CSV file.
post
Export reports for a specified tenant into CSV file.
post
Gets the details of a download job or gets a CSV report.
get
Run a report.
post
Authentication Configuration
Email One-time Password Configuration 2.0
Retrieve the email one-time password configuration.
get
Update the email one-time password configuration.
put
One-time Password Configuration 2.0
Retrieve the one-time password configuration.
get
Update the one-time password configuration.
put
Knowledge Questions Configuration
Retrieve the list of knowledge questions configuration profiles.
get
Retrieve a knowledge questions configuration profile.
get
Update a knowledge questions configuration profile.
put
SMS One-time Password Configuration 2.0
Retrieve the SMS one-time password configuration.
get
Update the SMS one-time password configuration.
put
Time-based One-time Password Configuration 2.0
Retrieve the time-based one-time password configuration.
get
Update the time-based one-time password configuration.
put
Voice One-time Password Configuration
Retrieve the voice one-time password configuration.
get
Update the voice one-time password configuration.
put
Authenticator Clients
Retrieve the list of authenticator clients.
get
Create an authenticator client.
post
Retrieve a specific authenticator client.
get
Update the editable attributes of a specific authenticator client.
put
Delete a specific authenticator client.
del
Update the editable attributes of a specific authenticator client.
patch
Retrieve the metadata of a specific authenticator client.
get
Update the metadata attributes of an authenticator client.
put
Update the metadata attributes of an authenticator client.
patch
Signature Authentication Configuration
Retrieve the signature authentication methods configuration.
get
Update the signature authentication method configuration.
put
Update the signature authentication methods configuration.
patch
General configuration
API Clients
Lists the API Clients
get
Create an API Client
post
Bulk deletes the API clients
patch
Gets a specific API client
get
Updates a specific API client
put
Deletes an API client
del
Gets a YAML response that contains the credentials for a specific client.
get
Session Exchange Configuration
Retrieve the configuration for session exchange.
get
Set the session exchange config.
put
Tenant Properties API 2.0
Retrieves a list of tenant properties for the specified tenant.
get
Replaces the tenant properties for the specified tenant.
put
Admin Entitlement Management
Create an admin entitlement.
post
Get the list of admin assignments.
post
Grant or revoke one or more admin entitlements to a group.
post
Grant or revoke one or more admin entitlements to a dynamic group.
post
Get the list of user added to or removed from dynamic admin entitlement.
post
Get the list of admin entitlements.
post
Grant or revoke one or more admin entitlements to a user.
post
Get an admin entitlement.
get
Grant or revoke an admin entitlement to one or more users and groups.
post
Delete an admin entitlement.
del
Update an admin entitlement.
patch
Get the children of an admin entitlement.
get
Add or remove one or more children for an admin entitlement.
post
Publish or discard an admin entitlement.
patch
Find the admin entitlements that are granted to a group.
get
Find the admin entitlements that are granted to the user that is logged in.
get
Find the admin entitlements that are granted to a dynamic group.
get
Find the admin entitlements that are granted to a user.
get
Certificates
Gets the list of personal certificates.
get
Import or generate a personal certificate.
post
Get a single personal certificate with the specified label.
get
Update a personal certificate.
put
Delete a personal certificate.
del
Gets the list of signer certificates.
get
Imports a signer certificate.
post
Gets the signer certificate with the given label.
get
Delete a signer certificate.
del
Push Credentials Management
Get all the sets of configured mobile push provider credentials.
get
Create a set of mobile push provider credentials.
post
Get a specific set of configured mobile push provider credentials.
get
Update a specific set of configured mobile push provider credentials.
put
Delete a specific set of configured mobile push provider credentials.
del
Password Vault
Password Vault Configuration
Retrieve the password vault configuration.
get
Update the password vault configuration.
put
Password Vault
Retrieve a password vault enrollment.
get
Update a password vault enrollment.
put
Delete a password vault enrollment.
del
Retrieve a password vault resource.
get
Update a password vault resource.
put
Delete a password vault resource.
del
Deprecated APIs
Access Policy Management v3.0 (deprecated)
Deprecated - Retrieve list of tenant policies.
get
Deprecated - Create a custom policy for tenant.
post
Deprecated - Retrieve the details of a particular policy specified with id.
get
Deprecated - Update the policy instance of tenant with specified id.
put
Deprecated - Delete custom policy of tenant with specified id.
del
OpenID Connect Consent Management (deprecated)
Deprecated - Retrieves the list of OIDC consents.
get
Deprecated - Bulk delete, or scope and entitlement removal of OIDC consents.
patch
Deprecated - Retrieves a specific OIDC consent.
get
Deprecated - Deletes a specific OIDC consent.
del
Deprecated - Retrieves the list of OIDC consents.
get
Deprecated - Bulk delete OIDC consents.
patch
Deprecated - Retrieves a specific OIDC consent.
get
Deprecated - Deletes a specific OIDC consent.
del
Deprecated - Retrieves the list of OIDC consents.
get
Deprecated - Bulk delete, or scope and entitlement removal of OIDC consents.
patch
Deprecated - Retrieves a specific OIDC consent.
get
Deprecated - Deletes a specific OIDC consent.
del
Deprecated - Bulk scope/entitlement removal of OIDC consents.
patch
IBM Security Verify API
Dynamic group management
Get all the dynamic groups for a tenant
get
Create dynamic group
post
Get details of the dynamic group associated with the provided group Id
get
Delete dynamic group
del
Update dynamic group
patch
Publish, discard or re-evaluate a dynamic group
patch
Get active membership for a dynamic group
get
Get membership of dynamic group to review
get
Check if the given attribute is used in the dynamic group condition set.
get
User management
Get all the active dynamic groups for a user
get
Reevaluate user's dynamic group
patch
Deprecated - Attribute Evaluation. Replaced by /v2.0/attributequery.
Tenant policy configuration
Retrieve the configuration for first factor policy. This is a list of policy Id, but only one policy is currently supported
get
Set the configuration for first factor policy. This is a list of policy Id, but only one policy is currently supported
put
Identity Sources V1 - Deprecated
Deprecated - Retrieve all the identity source instances of the tenant.
get
Deprecated - API to create an identity source instance for a tenant.
post
Deprecated - Retrieve all the identity source instances of the tenant that use the passord policy ID's specified in the 'search' query parameter.
get
Deprecated - Retrieve all the identity source instances of the tenant that have this property name and value.
get
Deprecated - Retrieve the details of a particular identity source instance of the tenant with the specified instance ID.
get
Deprecated - Update an identity source instance of the tenant with the specified instance ID.
put
Deprecated - Delete an identity source instance of the tenant with the specified instance ID.
del
Identity Sources V2
V2 Retrieve all the identity source instances of the tenant.
get
V2 API to create an identity source instance for a tenant.
post
V2 Retrieve all the identity source instances of the tenant that use the passord policy ID's specified in the 'search' query parameter.
get
V2 Retrieve all the identity source instances of the tenant that have this property name and value.
get
V2 Retrieve the details of a particular identity source instance of the tenant with the specified instance ID.
get
V2 Update an identity source instance of the tenant with the specified instance ID.
put
V2 Delete an identity source instance of the tenant with the specified instance ID.
del
Certification Campaign assignments v2.0
Retrieves the list of all assignments associated with the specified campaign instance from the specific tenant.
get
Retrieves the list of a assignments associated with the specified campaign instance from the specific tenant.
post
Retrieves the details of the assignment from the specific tenant.
get
Updates a specified assignment from the specific tenant.
put
Updates the list of assignments on a specified campaign instance that belong to a specified tenant.
patch
Certification Campaign configurations v2.0
Retrieves the details of the campaign configuration from the specific tenant.
get
Updates the campaign configuration for a specified campaign configuration from the specific tenant.
put
Retrieves the details of the Reviewer Types available for the specific Campaign Type.
get
Retrieves a list of campaign configurations from the specific tenant.
get
Creates a campaign configuration for the specific tenant.
post
Perform operations on a list of campaign configurations that belong to a specified tenant.
patch
Certification Campaign instances v2.0
Retrieves the list of a campaign instances from the specific tenant.
get
Perform operations on a collection of campaign instances that belong to a specific tenant.
patch
Retrieves the list of a campaign instances associated with the specified campaign configuration from the specific tenant.
get
Creates a preview campaign configuration for the specified tenant.
post
Retrieves the details of the campaign instance from the specific tenant.
get
Perform an operation on a specified campaign instance that belong to a specified tenant.
put
Certification Campaign statistics v2.0
Retrieves statistics of specific assignments within a given instance from the specific tenant.
get
Retrieves the assignment statistics of the campaign instance from the specific tenant.
get
Retrieves the campaign configuration statistics from the specific tenant.
get
Retrieves the campaign instance statistics from the specific tenant.
get
Certification Campaign assignments v1.0 - Deprecated
Deprecated - Retrieve all assignments in a given campaign instance
get
Deprecated - Retrieve all assignments in a given campaign instance.
post
Deprecated - Retrieve a specific assignment.
get
Deprecated - Modify a given assignment.
put
Deprecated - Retrieve a specific assignment.
get
Deprecated - Modify a given assignment.
put
Deprecated - Add new assignments to a continuous campaign instance.
post
Deprecated - Modify a given set of assignments.
patch
Deprecated - Retrieve all assignments, in a given campaign instance.
get
Deprecated - Retrieve all assignments in a given campaign instance.
post
Deprecated - Modify a given set of assignments.
patch
Deprecated - Refresh assignments in a continuous campaign.
post
Deprecated - Add new assignments to a continuous campaign.
post
Certification Campaign configurations v1.0 - Deprecated
Deprecated - Retrieve a specific campaign configuration.
get
Deprecated - Edit specific campaign configuration.
put
Deprecated - Delete specific campaign configuration.
del
Deprecated - Retrieve the campaign configurations.
get
Deprecated - Create a campaign configuration.
post
Deprecated - Edit campaign configurations.
patch
Certification Campaign instances v1.0 - Deprecated
Deprecated - Retrieve campaign instances.
get
Deprecated - Modify campaign instances.
patch
Deprecated - Retrieve instances corresponding to a specific campaign configuration.
get
Deprecated - Retrieve a specific campaign instance.
get
Deprecated - Modify specific campaign instance.
put
Deprecated - Retrieve campaign instances.
get
Deprecated - Retrieve specific campaign instance.
get
Deprecated - Create a preview campaign.
post
Deprecated - Retrieve instances corresponding to a specific campaign configuration.
get
Certification Campaign statistics v1.0 - Deprecated
Deprecated - Retrieve statistics of specific assignments within a given instance.
get
Deprecated - Retrieve statistics of specific assignments within a given instance.
get
Deprecated - Retrieve statistics of specific assignments.
get
Deprecated - Retrieve statistics of specific campaign instances.
get
Deprecated - Retrieve campaign statistics.
get
Deprecated - Retrieve statistics of specific campaign instances.
get
Deprecated - Retrieve statistics of specific assignments.
get
Dictionary Policy Management 3.0
Deprecated - Fetches the password dictionary policy in Cloud Directory.
get
Deprecated - Modifies the password dictionary policy in Cloud Directory.
patch
Fetches a list of password dictionary policies in Cloud Directory.
get
Create a password dictionary policy on the given tenant
post
Fetches the specified password dictionary policy in Cloud Directory.
get
Deletes a password dictionary policy from a specified tenant in Cloud Directory. Can only delete a password dictionary policy that is not predefined.
del
Modifies the specified password dictionary policy in Cloud Directory.
patch
Password Dictionary Management 3.0
Deletes all passwords from a specified tenant dictionary.
del
Add or remove passwords from the tenant password dictionary in Cloud Directory.
patch
Export the password dictionary from the specified tenant as a comma separated value (CSV) file.
get
Get the list of supported header names.
get
Import password dictionary for the specified tenant from a comma separated value (CSV) file.
post
Retrieves a list of CSV import requests that belong to the specified tenant.
get
Retrieves the details of a CSV import request that belong to the specified tenant.
get
Cancels a CSV import request for the specified tenant.
put
Deletes a CSV import request from the specified tenant.
del
Password Policy Management 3.0
Get all password policies for a specified tenant.
get
Create a password policy on the given tenant
post
Get a password policy with a given id for a specified tenant.
get
Deletes a password policy from a specified tenant in Cloud Directory. Can only delete a password policy that is not predefined.
del
Modify a password policy's attributes in Cloud Directory. It can be used to update one or more attributes.
patch
This API is used to get the password policy labels for a specified password policy on a given tenant using the specified locale.
get
Generate a password that satisfies the passwordStrength attributes in the given password policy.
get
Validate a password against a specific policy ID on a specific tenant.
post
FIDO MDS Configuration
External MFA Providers
Retrieve the list of external MFA provider configurations.
get
Create an external MFA provider configuration.
post
Retrieve an external MFA provider configuration.
get
Update an external MFA provider configuration.
put
Delete an external MFA provider configuration.
del
Retrieve the list of external MFA providers.
get
Retrieve the list of enrollments for an external MFA provider.
get
Action an authentication attempt via an external MFA provider.
post
Clears all cached enrollments of specific user for an external MFA provider
del
Retrieve the status of an authentication attempt.
get
Continue an authentication attempt via an external MFA provider.
post
Retrieve the list of enrollments for all external MFA providers.
get
Well-Known Uniform Resource Identifiers
Update the apple app site association file for iOS verifiable links.
put
Update digital asset link file for Android verifiable links.
put
Fetch the service's history of the apple-app-site-association file for iOS.
get
Fetch the service's history of the assetlinks.json file for Android.
get
Access Management
Find the children of an entitlement either requestable or requested or granted to self.
get
Get user access assignments in active and fulfillment failed state.
post
Get user access assignments statistics.
get
Fetch the access assignments of specific user.
post
Find the children of an application entitlement either requestable or requested or granted to a specific user.
get
Entitlement Management V2
Get the rights values associated to an assignment.
get
Update the rights values of an assignment.
put
Search the assignments.
post
Update the rights values of a role.
put
Get the right values of a permission assigned to a user.
get
Device manager configuration
Lists device managers
get
Create a device manager configuration.
post
Test a device manager connection
post
Get trusted certificates as a zip file.
get
Get a device-manager
get
Update a device manager configuration
put
Delete a device manager configuration.
del
PATCH a device manager configuration.
patch
Test a device manager connection
put
Lists device information
get
Delete user device
del
Lists your own device information
get
Deletes your own device
del
Lists uniqueuseridentifiers
get
Smartcard and other X.509 certificate provider configuration
Lists smartcard and other X.509 certificate providers.
get
Create a smartcard and other X.509 certificate provider.
post
Lists attributes and uniqueUserIdentifiers for a X.509 compliant certificate.
get
Get a smartcard and other X.509 certificate providers
get
Update a smartcard or X.509 certificate provider.
put
Delete a smartcard or X.509 certificate provider
del
Update a smartcard or X.509 certificate provider with PATCH
patch
Smartcard or certificate provider operations
Remove smartcard/X.509 certificate provider certificates for a specified user id.
del
Query Logs
Retrieves the trace logs
post
OpenID Connect Security Token Service Clients
Query STS clients
get
Create a STS client
post
Read a STS client
get
Update a STS client
put
Delete a STS client
del
OpenID Connect Token Types
Retrieves the list of custom OIDC token types.
get
Create a custom OIDC token type
post
Read a custom OIDC token type
get
Update a custom OIDC Token Type
put
Delete a custom OIDC token type
del
OpenID Connect Client Secret Rotation
Retrieve client secrets for a client
get
Rotate client secret
post
Bulk delete client secrets
patch
SAML 2.0 SP Alias Management
Retrieves the list of SP aliases
get
Creates an alias
post
Retrieves a specific SP alias
get
Deletes a specific SP alias
del
Retrieves the list of sp aliases belonging to user
get
Retrieves a specific sp alias belonging to user
get
Deletes a specific sp alias belonging to user
del
Threat Insights Configurations API
Fetch threat default configuration for specified tenant
get
Create the threat configuration for specified tenant
post
Fetch threat configuration for specified tenant and configuration id
get
Update the threat configuration for specified tenant for given configuration id
put
Update the threat configuration Status for specified tenant and configuration id
put
Delete the threat configuration for specified tenant for given configuration id
del
Webhook-Configuration
List Webhooks
get
Create a Webhook
post
Preflight a webhook configuration
post
Preflight a webhook configuration
post
List Webhook Purposes
get
Develop an transform
post
Fetch a Webhook
get
Update a Webhook
put
Delete a webhhook
del
Fetch webhook dead letters
get
Remove webhook dead letters
del
View the total number of deadletters a webhook
get
View the state of a deadletter reconciliation
get
Initiate a reconciliation of deadletters
post
Retrieve a dead letter
get
Remove a dead letter
del
Get webhook health
get
Current webhook status
get
Test a configured webhook
get
Tests a resource of a configured webhook
get
Create a STS client
post
https://{tenanturl}/v1.0/sts/oauth/clients
Create a OIDC STS client
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
https://
{tenant_url}
/v1.0/sts/oauth/clients
