OAuth and OIDC

OpenID Connect
OpenID Connect API v2

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
- Get the password policy for a specified tenant.get
- Update the password policy for a specified tenant.put
Users Management Version 2.0
Groups Management Version 2.0
User Self Care API

Attribute management

Attributes

Application management

Application Access
Entitlement Management

Authentication

Identity Sources
Identity Source Types
Authentication Token Exchange
- Exchange a valid bearer token for an authenticated browser sessionget
Authentication Manage User Sessions
- Delete random session for the user.delete
Social JWT Exchange
- Exchange a valid social JWT for an IBM Security Verify access token.post
FIDO Configuration
QR Code Login Configuration
- Retrieve the QR code login configuration.get
- Update the QR code login configuration.put
reCAPTCHA
FIDO
QR Code Login
Password Authentication

Multi-factor authentication

Authentication Factors 2.0
Email One-time Password 2.0
One-time Password
Knowledge Questions
SMS One-time Password 2.0
Time-based One-time Password 2.0
Voice One-time Password
Authenticators
Signature Authentication

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
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
SAML 2.0 Federations Management
WS Federation Management
- Enable WS-Federation audit trace for the tenantpost
- Enable WS-Federation audit tracepost

Access & Risk Policies

Access Policy Management V5.0

Branding & customization

Customization - Themes

Lifecycle & Governance

Adapter Management
Provisioning Management
Certification Campaign statistics
Certification Campaign assignments
Certification Campaign configurations
Certification Campaign instances
Access Request Management V1.0

Identity agents

Agent Bridge Support Service

Data privacy & consent

Data Privacy and Consent
Data Privacy and Consent Management

Event analytics & reports

Events
- Get all events for a tenant.get
Reports
- Export reports for a specified tenant into CSV file.post
- 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
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
Signature Authentication Configuration

General configuration

API Clients
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
Certificates
Push Credentials Management

Password Vault

Password Vault Configuration
- Retrieve the password vault configuration.get
- Update the password vault configuration.put
Password Vault

Deprecated APIs

Deprecated - Attribute Evaluation. Replaced by /v2.0/attributequery.
- Deprecated - Preview the value that would be computed for this attribute.post
Access Policy Management v3.0 (deprecated)
OpenID Connect Consent Management (deprecated)
Customization - Templates (deprecated)
- Deprecated - Download templatesget
- Deprecated - Upload Template Customizationspost

IBM Security Verify API

Tenant policy configuration
- Retrieve the configuration for first factor policy. This is a list of policy Id, but only one policy is currently supportedget
- Set the configuration for first factor policy. This is a list of policy Id, but only one policy is currently supportedput
External MFA Providers
Access Management
Device manager configuration
Smartcard and other X.509 certificate provider configuration
Smartcard or certificate provider operations
- Remove smartcard/X.509 certificate provider certificates for a specified user id.delete
Webhook-Configuration

OAuth and OIDC

OpenID Connect
OpenID Connect API v2

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
- Get the password policy for a specified tenant.get
- Update the password policy for a specified tenant.put
Users Management Version 2.0
Groups Management Version 2.0
User Self Care API

Attribute management

Attributes

Application management

Application Access
Entitlement Management

Authentication

Identity Sources
Identity Source Types
Authentication Token Exchange
- Exchange a valid bearer token for an authenticated browser sessionget
Authentication Manage User Sessions
- Delete random session for the user.delete
Social JWT Exchange
- Exchange a valid social JWT for an IBM Security Verify access token.post
FIDO Configuration
QR Code Login Configuration
- Retrieve the QR code login configuration.get
- Update the QR code login configuration.put
reCAPTCHA
FIDO
QR Code Login
Password Authentication

Multi-factor authentication

Authentication Factors 2.0
Email One-time Password 2.0
One-time Password
Knowledge Questions
SMS One-time Password 2.0
Time-based One-time Password 2.0
Voice One-time Password
Authenticators
Signature Authentication

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
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
SAML 2.0 Federations Management
WS Federation Management
- Enable WS-Federation audit trace for the tenantpost
- Enable WS-Federation audit tracepost

Access & Risk Policies

Access Policy Management V5.0

Branding & customization

Customization - Themes

Lifecycle & Governance

Adapter Management
Provisioning Management
Certification Campaign statistics
Certification Campaign assignments
Certification Campaign configurations
Certification Campaign instances
Access Request Management V1.0

Identity agents

Agent Bridge Support Service

Data privacy & consent

Data Privacy and Consent
Data Privacy and Consent Management

Event analytics & reports

Events
- Get all events for a tenant.get
Reports
- Export reports for a specified tenant into CSV file.post
- 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
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
Signature Authentication Configuration

General configuration

API Clients
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
Certificates
Push Credentials Management

Password Vault

Password Vault Configuration
- Retrieve the password vault configuration.get
- Update the password vault configuration.put
Password Vault

Deprecated APIs

Deprecated - Attribute Evaluation. Replaced by /v2.0/attributequery.
- Deprecated - Preview the value that would be computed for this attribute.post
Access Policy Management v3.0 (deprecated)
OpenID Connect Consent Management (deprecated)
Customization - Templates (deprecated)
- Deprecated - Download templatesget
- Deprecated - Upload Template Customizationspost

IBM Security Verify API

Tenant policy configuration
- Retrieve the configuration for first factor policy. This is a list of policy Id, but only one policy is currently supportedget
- Set the configuration for first factor policy. This is a list of policy Id, but only one policy is currently supportedput
External MFA Providers
Access Management
Device manager configuration
Smartcard and other X.509 certificate provider configuration
Smartcard or certificate provider operations
- Remove smartcard/X.509 certificate provider certificates for a specified user id.delete
Webhook-Configuration

Delete the authenticated user's Cloud Directory account.

delete https://{tenanturl}/v2.0/Me

Entitlement required: anyone (Any authenticated user).

By default, an email is sent to the user that the account was deleted. The email template for branding is at "notifications/user_management/profile/{locale}/account_deleted_email.xml". Pass in the themeId query parameter to brand the email template for notifications.
To turn off email notifications, send notifyType=NONE as a query parameter.

This API requires an authenticated user's access token that is generated from an application client during sign-on. This API does not support the use of an API client-generated access token.
Send a valid user access token in the authorization header, by using the bearer authentication scheme.

Query Params

notifyType

string

An optional query parameter that denotes the notification type. If not present, the EMAIL notification is used. Specify NONE if no notification to the user that their account has been deleted is required.

themeId

string

The identifier of the theme that you want to apply.

Responses

204

No Content.

Response body

object

schemas

array of strings

required

An array of strings that contain the URIs that indicate the namespaces of the SCIM schemas that define the attributes in the current JSON structure. The schema "urn:ietf:params:scim:api:messages:2.0:Error" is the URI as required by the SCIM specification.

schemas*

status

string

required

The HTTP status code expressed as a JSON string.

detail

string

A detailed human-readable message.

Response body

object

schemas

array of strings

required

schemas*

status

string

required

The HTTP status code expressed as a JSON string.

detail

string

A detailed human-readable message.

Response body

object

schemas

array of strings

required

schemas*

status

string

required

The HTTP status code expressed as a JSON string.

detail

string

A detailed human-readable message.

Response body

object

schemas

array of strings

required

schemas*

status

string

required

The HTTP status code expressed as a JSON string.

detail

string

A detailed human-readable message.

Updated over 1 year ago

Replaces the authenticated user's attributes in Cloud Directory.

Change the authenticated user's password.

Did this page help you?

Language

URL


xxxxxxxxxx
1
curl --request DELETE \
2
     --url https://tenant_url/v2.0/Me \
3
     --header 'accept: application/json'

Choose an example:

application/scim+json

Updated over 1 year ago

Replaces the authenticated user's attributes in Cloud Directory.

Change the authenticated user's password.

Did this page help you?

OAuth and OIDC
OpenID Connect
Retrieve user informationpost
Retrieve user informationget
Get the access token.post
Revoke the token.post
Get the provider's JSON Web Key Set (JWKS).get
Introspect the token.post
Authorize device to use OIDC.post
Delete a dynamic client.delete
Read a dynamic client.get
Create a dynamic client.post
Authorize the user to use OIDC.post
Authorize the user to use OIDC.get
Get provider's metadata.get
OpenID Connect API v2
Delete a dynamic client.delete
Read a dynamic client.get
Create a dynamic client.post
Revoke the token.post
Retrieve user informationpost
Retrieve user informationget
Introspect the tokenpost
Get the access token.post
Authorize the user to use OIDC.post
Authorize the user to use OIDC.get
Get provider's metadataget

Users & Groups
Account expiration configuration
Set the account expiration config.put
Retrieve the global configuration for attribute mapping that can be overridden in individual identity providers.get
Password Policy Management 2.0
Update the password policy for a specified tenant.put
Get the password policy for a specified tenant.get
Users Management Version 2.0
Reset a user's password.patch
Compare a clear text value to a custom hashed attribute value for a user.post
Modify a user's attributes in Cloud Directory. It can be used to update one or more attributes.patch
Deletes a user from a specified tenant in Cloud Directory.delete
Replaces the user's attributes in Cloud Directory.put
Retrieves the details of a user in Cloud Directory for a tenant.get
Retrieves the total number of users under a tenant in the Cloud Directory.get
Authenticate a user name and password.post
Creates a user in Cloud Directory.post
Retrieves a list of users that belong to a specified tenant and match the search filter criteria.get
Deprecated - Delete a custom schema attribute for the specified tenant in Cloud Directory.delete
Deprecated - Modify a custom schema attribute for the specified tenant in Cloud Directoryput
Deprecated - Retrieve the details of a schema attribute in Cloud Directory for a tenant.get
Deprecated - Create a custom schema attribute to extend the SCIM API model for managing user accounts.post
Deprecated - Retrieve the list of a schema attributes in Cloud Directory for a tenant.get
Retrieves the SCIM capabilities enabled for the tenant.get
Retrieves a list of a manager's reportees that belong to a specified tenant and match the search filter criteria.get
Change the authenticated user's password.post
Delete the authenticated user's Cloud Directory account.delete
Replaces the authenticated user's attributes in Cloud Directory.put
Retrieves the account details of the authenticated user in Cloud Directory.get
Deletes a CSV import request from the specified tenant.delete
Cancels a CSV import request for the specified tenant.put
Retrieves the details of a CSV import request that belong to the specified tenant.get
Retrieves a list of CSV import requests that belong to the specified tenant.get
Import users for the specified tenant from a comma separated value (CSV) file.post
Get the list of supported header names.get
Delete users for the specified tenant from a (CSV) file.post
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
Groups Management Version 2.0
This API is used to modify a group's attributes. It can be used to update one or more attributes.patch
Delete a group from a specified tenant.delete
Updates the group's attributes for a specified tenant.put
Retrieves the details of a group for a specified tenant.get
Retrieves the total number of groups under a tenant in the Cloud Directory.get
Creates a group for a specified tenant.post
Retrieves a list of groups that belong to the specified tenant and match the search criteria.get
Import groups for the specified tenant from a comma separated value (CSV) file.post
User Self Care API
Validates the authentication attempt that is associated with the current step in the username recovery flow.post
Recover the user's forgotten user name.put
Initiate a forgot username request by using an authentication mechanism.post
Validates the authentication attempt that is associated with the current step in the reset password flow.post
Reset the user's forgotten password.put
Initiate a reset password request by using an authentication mechanism.post

Attribute management
Attributes
Reverts a global attribute to the default configurationput
Modifies selected properties of an attributepatch
Deletes an attributedelete
Modifies an attributeput
Gets an attributeget
Gets the list of existing attribute tagsget
Bulk management operations of attributespatch
Creates an attributepost
Lists all attributesget
Retrieves the list of attribute functions that are configured for the specified tenantget

Application management
Application Access
API to determine if a user is entitled to an application.post
Fetches the applications that are entitled to a user.get
Gets all operations performed in an Account Sync operationget
Get All account synchronization status for all applications of given tenant.get
Updates entitlements to an application.post
Fetches the entitlements of an application.get
Updates the attributes of an application accessible to the owner.put
Fetches the details of an application accessible to owner.get
Searches for the applications of an owner.get
Retrieves a list of application ids that have the specified auth policy id attached.get
Provides mechanism to adopt an Orphan accountpost
Retrieves all supporting data for a given application.get
Gets the Application account list details for specified account synchronization id.get
Stop given account synchronization of an application.post
Gets adoption stats details of account synchronization for an application.get
Get Last run reconciliation status for an application.get
Start / Stop Account Synchronization.post
Suspend/Restore/Orphan/Unmanage/deprovision an Account identified by this applicationId, userId.post
Get attribute values delta for an account for the application.get
Get the account attributes of given account associated with an application.get
Remediate Non-Compliant accounts for an application.post
Gets the list of accounts for the specified application.get
Deletes the application that is specified by the application ID.delete
Updates an application.put
Gets the details of an application.get
Gets the summary stats of all applications for a given tenant.get
Update custom rule.put
Get rule definition.get
Create custom rule.post
Checks if the identity source is configured with an application.get
Creates an instance of an application for a tenant.post
Gets the list of all applications that were onboarded by tenant administrator.get
Retry a failed operationpost
Gets details of the specified operationget
Retry a list of failed operations.post
Gets the list of all the operations that are performed on accounts of this tenant.get
Entitlement Management
Get the right values of a permission assigned to a user.get
Get the entitlements that are granted to a user.get
Get all the applications that are granted to a user.get
Check if a user is granted to an application.post
Check if a user is granted to an application.get
Get the entitlements granted to the logged user.get
Get the entitlements granted to a group.get
Publish or discard an entitlement.patch
Update the rights values of a role.patch
Add or remove one or more children for an entitlement.post
Find the children of an entitlement.get
Update an entitlement.patch
Delete an entitlement.delete
Grant or revoke an entitlement to one or more users and groups.post
Get the entitlement details.get
Grant or revoke one or more entitlements to a user.post
Search the entitlements.post
Get the list of user added to or removed from dynamic entitlement.post
Grant or revoke one or more entitlements to a group.post
Search the assignments.post
Creates a new entitlement.post
Update the rights values of an assignment.patch
Get the rights values associated to an assignment.get

Authentication
Identity Sources
Delete an identity source instance of the tenant with the specified instance ID.delete
Update an identity source instance of the tenant with the specified instance ID.put
Retrieve the details of a particular identity source instance of the tenant with the specified instance ID.get
Retrieve all the identity source instances of the tenant that have this property name and value.get
Retrieve all the identity source instances of the tenant that use the passord policy ID's specified in the 'search' query parameter.get
Create an identity source instance for a tenant.post
Retrieve all the identity source instances of the tenant.get
Identity Source Types
Retrieve the metadata of a particular SAML Enterprise.get
Retrieve the details of a particular identity source types.get
Retrieve the details of all the identity source types.get
Authentication Token Exchange
Exchange a valid bearer token for an authenticated browser sessionget
Authentication Manage User Sessions
Delete random session for the user.delete
Social JWT Exchange
Exchange a valid social JWT for an IBM Security Verify access token.post
FIDO Configuration
Delete a relying party configuration.delete
Update a relying party configuration.put
Retrieve a relying party configuration.get
Create a relying party configuration.post
Retrieve the list of relying party configurations.get
Delete a metadata entry.delete
Update a metadata entry.put
Retrieve a metadata entry.get
Create a metadata entry.post
Retrieve the list of metadata entries.get
QR Code Login Configuration
Update the QR code login configuration.put
Retrieve the QR code login configuration.get
reCAPTCHA
Delete a reCAPTCHA configurationdelete
Update a reCAPTCHA configurationput
Retrieve a reCAPTCHA configurationget
Create a reCAPTCHA configurationpost
Retrieve the list of reCAPTCHA configurationsget
FIDO
Complete a FIDO registration.post
Initiate a FIDO registration.post
Complete a FIDO authentication.post
Initiate a FIDO authentication.post
Resolve an rpId.post
Delete a FIDO registration.delete
Update a FIDO registration.put
Retrieve a FIDO registration.get
Retrieve the list of FIDO registrations.get
QR Code Login
Cancel a QR code login verification.delete
Attempt a QR code login verification.post
Retrieve a QR code login verification.get
Create a QR code login verification.get
Password Authentication
Reset a user's password for an identity source.post
Attempt password authentication with an identity source.post
Change a user's password for an identity source.put
Retrieve the list of valid password based identity sources.get

Multi-factor authentication
Authentication Factors 2.0
Discover the availability of an authentication factor.get
Discover the availability of all authentication factors.get
Retrieve the list of authentication factor enrollments.get
Email One-time Password 2.0
Cancel a email one-time password verification.delete
Attempt a email one-time password verification.post
Retrieve a email one-time password verification.get
Create a email one-time password verification.post
Delete a email one-time password enrollment.delete
Update a email one-time password enrollment.put
Retrieve a email one-time password enrollment.get
Cancel a transient email one-time password verification.delete
Attempt a transient email one-time password verification.post
Retrieve a transient email one-time password verification.get
Create a transient email one-time password verification.post
Create a email one-time password enrollment.post
Retrieve the list of email one-time password enrollments.get
One-time Password
Cancel a one-time password verification.delete
Attempt a one-time password verification.post
Retrieve a one-time password verification.get
Create a one-time password verification.post
Knowledge Questions
Delete a knowledge question verification.delete
Attempt a knowledge question verification.post
Retrieve a knowledge question verification.get
Create a knowledge question verification.post
Delete a knowledge question enrollment.delete
Update a knowledge question enrollment.put
Retrieve a knowledge question enrollment.get
Create a knowledge question enrollment.post
Retrieve the list of knowledge question enrollments.get
SMS One-time Password 2.0
Cancel a SMS one-time password verification.delete
Attempt a SMS one-time password verification.post
Retrieve a SMS one-time password verification.get
Create a SMS one-time password verification.post
Delete a SMS one-time password enrollment.delete
Update a SMS one-time password enrollment.put
Retrieve a SMS one-time password enrollment.get
Cancel a transient SMS one-time password verification.delete
Attempt a transient SMS one-time password verification.post
Retrieve a transient SMS one-time password verification.get
Create a transient SMS one-time password verification.post
Create a SMS one-time password enrollment.post
Retrieve the list of SMS one-time password enrollments.get
Time-based One-time Password 2.0
Delete a time-based one-time password enrollment.delete
Attempt a time-based one-time password verification.post
Update a time-based one-time password enrollment.put
Retrieve a time-based one-time password enrollment.get
Create a time-based one-time password enrollment.post
Retrieve the list of time-based one-time password enrollments.get
Voice One-time Password
Cancel a voice one-time password verification.delete
Attempt a voice one-time password verification.post
Retrieve a voice one-time password verification.get
Create a voice one-time password verification.post
Delete a voice one-time password enrollment.delete
Update a voice one-time password enrollment.put
Retrieve a voice one-time password enrollment.get
Cancel a transient voice one-time password verification.delete
Attempt a transient voice one-time password verification.post
Retrieve a transient voice one-time password verification.get
Create a transient voice one-time password verification.post
Create a voice one-time password enrollment.post
Retrieve the list of voice one-time password enrollments.get
Authenticators
Complete a specific verification transaction.post
Retrieve a specific verification transaction.get
Initiate a verification transaction.post
Retrieve the list of verification transactions.get
Update the editable attributes of a specific authenticator registration.patch
Delete a specific authenticator registration.delete
Update the editable attributes of a specific authenticator registration.put
Retrieve a specific authenticator registration.get
Complete or refresh an authenticator registration.post
Initiate an authenticator registration.post
Retrieve the list of available authenticator clients.get
Retrieve the list of registered authenticators.get
Signature Authentication
Update the editable attributes of a specific signature enrollment.patch
Delete a specific signature enrollment.delete
Update the editable attributes of a specific signature enrollment.put
Retrieve a specific signature enrollment.get
Enroll a signature authentication method.post
Retrieve the list of signature enrollments.get

Federation
Identity Provider Attribute Mappings
Set the global attribute mappings for identity sources.put
Retrieve the global configuration for attribute mapping that can be overridden in individual identity providers.get
OpenID Connect Grant Management
Deletes a specific OIDC grant.delete
Retrieves a specific OIDC grant.get
Bulk delete, disable, or enable OIDC grants.patch
Retrieves the list of OIDC grants.get
Deletes a specific OIDC grant.delete
Retrieves a specific OIDC grant.get
Bulk delete, disable, or enable OIDC grants.patch
Retrieves the list of OIDC grants.get
Deletes a specific OIDC grant.delete
Retrieves a specific OIDC grant.get
Bulk delete, disable, or enable OIDC grants.patch
Retrieves the list of OIDC grants.get
OpenID Connect Dynamic Client Profile
Update dynamic client profile.put
Read dynamic client profile.get
OpenID Connect Federation
Updates the OpenID Connect federation configuration.put
Retrieves the OpenID Connect federation configuration.get
SAML 2.0 Alias Management
Deletes a specific alias belonging to userdelete
Retrieves a specific alias belonging to userget
Retrieves the list of aliases belonging to userget
Deletes a specific aliasdelete
Retrieves a specific aliasget
Retrieves the list of aliasesget
SAML 2.0 Federations Management
Exports a federation metadataget
Update a Federationput
Get a Federationget
Get all Federationsget
WS Federation Management
Enable WS-Federation audit tracepost
Enable WS-Federation audit trace for the tenantpost

Access & Risk Policies
Access Policy Management V5.0
delete an access policy revisiondelete
update a access policy revisionput
retrieve a revision for an access policyget
retrieve the revisions for an access policyget
delete an access policydelete
create an access policy revisionpost
update a access policyput
retrieve a access policyget
create an access policypost
retrieve access policiesget

Branding & customization
Customization - Themes
Deletes a customization for a specific template file in a themedelete
Update a specific template file for a themeput
Download a specific template file from a themeget
Delete a theme registrationdelete
Update a theme registrationput
Download theme-based templatesget
Register a new themepost
List all the themesget
Reset customizationsdelete

Lifecycle & Governance
Adapter Management
Publish the profilepost
Get webui template in the system for a given profile id and template id.get
Get all profiles in system for a tenant with a given template id.get
Delete specified profiledelete
Update draft in system.put
Get details of the specified profileget
List all profiles using the attribute.get
Create draft in system.post
Get all custom profiles in system.get
Provisioning Management
Delete provisioning policy for an application.delete
Create a provisioning policy for an applicatication. Provisioning policy enables or disables publishing of provisioning events for the application.post
Update provisioning policy for an application. In addition resends all events for the application.put
Get provisioning policy for an application.get
Certification Campaign statistics
Retrieve statistics of specific assignments within a given instance.get
Retrieve statistics of specific campaign instances.get
Retrieve statistics of specific assignments.get
Retrieve statistics of specific assignments within a given instance.get
Retrieve statistics of specific campaign instances.get
Retrieve campaign statistics.get
Retrieve statistics of specific assignments.get
Certification Campaign assignments
Retrieve all assignments in a given campaign instance.post
Retrieve all assignments, in a given campaign instance.get
Modify a given set of assignments.patch
Modify a given assignment.put
Retrieve a specific assignment.get
Retrieve all assignments in a given campaign instance.post
Retrieve all assignments in a given campaign instanceget
Refresh assignments in a continuous campaign.post
Modify a given set of assignments.patch
Add new assignments to a continuous campaign instance.post
Add new assignments to a continuous campaign.post
Modify a given assignment.put
Retrieve a specific assignment.get
Certification Campaign configurations
Delete specific campaign configuration.delete
Edit specific campaign configuration.put
Retrieve a specific campaign configuration.get
Edit campaign configurations.patch
Create a campaign configuration.post
Retrieve the campaign configurations.get
Certification Campaign instances
Retrieve specific campaign instance.get
Retrieve campaign instances.get
Retrieve instances corresponding to a specific campaign configuration.get
Create a preview campaign.post
Modify specific campaign instance.put
Retrieve a specific campaign instance.get
Modify campaign instances.patch
Retrieve campaign instances.get
Retrieve instances corresponding to a specific campaign configuration.get
Access Request Management V1.0
Delete a workflow configuration.delete
Replace an existing workflow configuration.put
Find a workflow configuration by ID.get
Find a workflow configuration.get
Find all requestable applications in the catalog.get
Deprecated - Cancel a list of requestspost
Deprecated - Create a fine grained access request for selfpost
Deprecated - Get the summary of self request statisticsget
Deprecated - Get statistical view of self requestsget
Create a self requestpost
Deprecated - Search the self requestsget
Cancel a list of requestspost
Create a fine grained access requestspost
Send a reminder to all approvers of a requestpost
Add a justificationpost
Get request detailsget
Get the summary of request statisticsget
Get statistical view of requestsget
Create a requestpost
Search the requestsget
Execute actions for a list of requestspost
Get statistical summary of requests for approvalget
Get statistical view of requests for approvalget
Search requests of an approverget
Delete all the requests that are filtered by one or more query parameters.delete
Delete a request by iddelete
Get the requestable access list for self.post
Get details of specified requestable access.get

Identity agents
Agent Bridge Support Service
Retrieve the API Client credentials.get
Delete an agent configuration.delete
Update a specific agent configuration.put
Retrieve a specific agent's configuration.get
Retrieve corrupted agent configuration(s) which can't be decrypted due to missing certificateget
Create an agent configuration.post
Retrieve agent configurations.get

Data privacy & consent
Data Privacy and Consent
Provides the data usage approval.post
Presents the data subject information to the user.post
Bulk create or patch consent records.patch
Create or update a consent record.post
Data Privacy and Consent Management
Delete a specific consent record from a tenant.delete
Retrieve a specific consent record.get
Bulk delete consent records.patch
Retrieve a list of consent records.get

Event analytics & reports
Events
Get all events for a tenant.get
Reports
Run a report.post
Export reports for a specified tenant into CSV file.post

Authentication Configuration
Email One-time Password Configuration 2.0
Update the email one-time password configuration.put
Retrieve the email one-time password configuration.get
One-time Password Configuration 2.0
Update the one-time password configuration.put
Retrieve the one-time password configuration.get
Knowledge Questions Configuration
Update a knowledge questions configuration profile.put
Retrieve a knowledge questions configuration profile.get
Retrieve the list of knowledge questions configuration profiles.get
SMS One-time Password Configuration 2.0
Update the SMS one-time password configuration.put
Retrieve the SMS one-time password configuration.get
Time-based One-time Password Configuration 2.0
Update the time-based one-time password configuration.put
Retrieve the time-based one-time password configuration.get
Voice One-time Password Configuration
Update the voice one-time password configuration.put
Retrieve the voice one-time password configuration.get
Authenticator Clients
Update the metadata attributes of an authenticator client.patch
Update the metadata attributes of an authenticator client.put
Retrieve the metadata of a specific authenticator client.get
Update the editable attributes of a specific authenticator client.patch
Delete a specific authenticator client.delete
Update the editable attributes of a specific authenticator client.put
Retrieve a specific authenticator client.get
Create an authenticator client.post
Retrieve the list of authenticator clients.get
Signature Authentication Configuration
Update the signature authentication methods configuration.patch
Update the signature authentication method configuration.put
Retrieve the signature authentication methods configuration.get

General configuration
API Clients
Gets a YAML response that contains the credentials for a specific client.get
Deletes an API clientdelete
Updates a specific API clientput
Gets a specific API clientget
Bulk deletes the API clientspatch
Create an API Clientpost
Lists the API Clientsget
Session Exchange Configuration
Set the session exchange config.put
Retrieve the configuration for session exchange.get
Tenant Properties API 2.0
Replaces the tenant properties for the specified tenant.put
Retrieves a list of tenant properties for the specified tenant.get
Admin Entitlement Management
Find the admin entitlements that are granted to a user.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 group.get
Publish or discard an admin entitlement.patch
Add or remove one or more children for an admin entitlement.post
Get the children of an admin entitlement.get
Update an admin entitlement.patch
Delete an admin entitlement.delete
Grant or revoke an admin entitlement to one or more users and groups.post
Get an admin entitlement.get
Grant or revoke one or more admin entitlements to a user.post
Get the list of admin entitlements.post
Get the list of user added to or removed from dynamic admin entitlement.post
Grant or revoke one or more admin entitlements to a group.post
Get the list of admin assignments.post
Create an admin entitlement.post
Certificates
Delete a signer certificate.delete
Gets the signer certificate with the given label.get
Imports a signer certificate.post
Gets the list of signer certificates.get
Delete a personal certificate.delete
Update a personal certificate.put
Get a single personal certificate with the specified label.get
Import or generate a personal certificate.post
Gets the list of personal certificates.get
Push Credentials Management
Delete a specific set of configured mobile push provider credentials.delete
Update a specific set of configured mobile push provider credentials.put
Get a specific set of configured mobile push provider credentials.get
Create a set of mobile push provider credentials.post
Get all the sets of configured mobile push provider credentials.get

Password Vault
Password Vault Configuration
Update the password vault configuration.put
Retrieve the password vault configuration.get
Password Vault
Delete a password vault resource.delete
Update a password vault resource.put
Retrieve a password vault resource.get
Delete a password vault enrollment.delete
Update a password vault enrollment.put
Retrieve a password vault enrollment.get

Deprecated APIs
Deprecated - Attribute Evaluation. Replaced by /v2.0/attributequery.
Deprecated - Preview the value that would be computed for this attribute.post
Access Policy Management v3.0 (deprecated)
Deprecated - Delete custom policy of tenant with specified id.delete
Deprecated - Update the policy instance of tenant with specified id.put
Deprecated - Retrieve the details of a particular policy specified with id.get
Deprecated - Create a custom policy for tenant.post
Deprecated - Retrieve list of tenant policies.get
OpenID Connect Consent Management (deprecated)
Deprecated - Bulk scope/entitlement removal of OIDC consents.patch
Deprecated - Deletes a specific OIDC consent.delete
Deprecated - Retrieves a specific OIDC consent.get
Deprecated - Bulk delete, or scope and entitlement removal of OIDC consents.patch
Deprecated - Retrieves the list of OIDC consents.get
Deprecated - Deletes a specific OIDC consent.delete
Deprecated - Retrieves a specific OIDC consent.get
Deprecated - Bulk delete OIDC consents.patch
Deprecated - Retrieves the list of OIDC consents.get
Deprecated - Deletes a specific OIDC consent.delete
Deprecated - Retrieves a specific OIDC consent.get
Deprecated - Bulk delete, or scope and entitlement removal of OIDC consents.patch
Deprecated - Retrieves the list of OIDC consents.get
Customization - Templates (deprecated)
Deprecated - Upload Template Customizationspost
Deprecated - Download templatesget

IBM Security Verify API
Tenant policy configuration
Set the configuration for first factor policy. This is a list of policy Id, but only one policy is currently supportedput
Retrieve the configuration for first factor policy. This is a list of policy Id, but only one policy is currently supportedget
External MFA Providers
Retrieve the list of enrollments for all external MFA providers.get
Continue an authentication attempt via an external MFA provider.post
Retrieve the status of an authentication attempt.get
Clears all cached enrollments of specific user for an external MFA providerdelete
Action an authentication attempt via an external MFA provider.post
Retrieve the list of enrollments for an external MFA provider.get
Retrieve the list of external MFA providers.get
Delete an external MFA provider configuration.delete
Update an external MFA provider configuration.put
Retrieve an external MFA provider configuration.get
Create an external MFA provider configuration.post
Retrieve the list of external MFA provider configurations.get
Access Management
Find the children of an application entitlement either requestable or requested or granted to a specific user.get
Fetch the access assignments of specific user.post
Get user access assignments statistics.get
Get user access assignments in active and fulfillment failed state.post
Find the children of an entitlement either requestable or requested or granted to self.get
Device manager configuration
Lists uniqueuseridentifiersget
Deletes your own devicedelete
Lists your own device informationget
Delete user devicedelete
Lists device informationget
Test a device manager connectionput
PATCH a device manager configuration.patch
Delete a device manager configuration.delete
Update a device manager configurationput
Get a device-managerget
Get trusted certificates as a zip file.get
Test a device manager connectionpost
Create a device manager configuration.post
Lists device managersget
Smartcard and other X.509 certificate provider configuration
Update a smartcard or X.509 certificate provider with PATCHpatch
Delete a smartcard or X.509 certificate providerdelete
Update a smartcard or X.509 certificate provider.put
Get a smartcard and other X.509 certificate providersget
Lists attributes and uniqueUserIdentifiers for a X.509 compliant certificate.get
Create a smartcard and other X.509 certificate provider.post
Lists smartcard and other X.509 certificate providers.get
Smartcard or certificate provider operations
Remove smartcard/X.509 certificate provider certificates for a specified user id.delete
Webhook-Configuration
Tests a resource of a configured webhookget
Test a configured webhookget
Current webhook statusget
Get webhook healthget
Remove a dead letterdelete
Retrieve a dead letterget
Initiate a reconciliation of deadletterspost
View the state of a deadletter reconciliationget
View the total number of deadletters a webhookget
Remove webhook dead lettersdelete
Fetch webhook dead lettersget
Delete a webhhookdelete
Update a Webhookput
Fetch a Webhookget
Develop an transformpost
List Webhook Purposesget
Preflight a webhook configurationpost
Preflight a webhook configurationpost
Create a Webhookpost
List Webhooksget

OAuth and OIDC
OpenID Connect
Retrieve user informationpost
Retrieve user informationget
Get the access token.post
Revoke the token.post
Get the provider's JSON Web Key Set (JWKS).get
Introspect the token.post
Authorize device to use OIDC.post
Delete a dynamic client.delete
Read a dynamic client.get
Create a dynamic client.post
Authorize the user to use OIDC.post
Authorize the user to use OIDC.get
Get provider's metadata.get
OpenID Connect API v2
Delete a dynamic client.delete
Read a dynamic client.get
Create a dynamic client.post
Revoke the token.post
Retrieve user informationpost
Retrieve user informationget
Introspect the tokenpost
Get the access token.post
Authorize the user to use OIDC.post
Authorize the user to use OIDC.get
Get provider's metadataget

Users & Groups
Account expiration configuration
Set the account expiration config.put
Retrieve the global configuration for attribute mapping that can be overridden in individual identity providers.get
Password Policy Management 2.0
Update the password policy for a specified tenant.put
Get the password policy for a specified tenant.get
Users Management Version 2.0
Reset a user's password.patch
Compare a clear text value to a custom hashed attribute value for a user.post
Modify a user's attributes in Cloud Directory. It can be used to update one or more attributes.patch
Deletes a user from a specified tenant in Cloud Directory.delete
Replaces the user's attributes in Cloud Directory.put
Retrieves the details of a user in Cloud Directory for a tenant.get
Retrieves the total number of users under a tenant in the Cloud Directory.get
Authenticate a user name and password.post
Creates a user in Cloud Directory.post
Retrieves a list of users that belong to a specified tenant and match the search filter criteria.get
Deprecated - Delete a custom schema attribute for the specified tenant in Cloud Directory.delete
Deprecated - Modify a custom schema attribute for the specified tenant in Cloud Directoryput
Deprecated - Retrieve the details of a schema attribute in Cloud Directory for a tenant.get
Deprecated - Create a custom schema attribute to extend the SCIM API model for managing user accounts.post
Deprecated - Retrieve the list of a schema attributes in Cloud Directory for a tenant.get
Retrieves the SCIM capabilities enabled for the tenant.get
Retrieves a list of a manager's reportees that belong to a specified tenant and match the search filter criteria.get
Change the authenticated user's password.post
Delete the authenticated user's Cloud Directory account.delete
Replaces the authenticated user's attributes in Cloud Directory.put
Retrieves the account details of the authenticated user in Cloud Directory.get
Deletes a CSV import request from the specified tenant.delete
Cancels a CSV import request for the specified tenant.put
Retrieves the details of a CSV import request that belong to the specified tenant.get
Retrieves a list of CSV import requests that belong to the specified tenant.get
Import users for the specified tenant from a comma separated value (CSV) file.post
Get the list of supported header names.get
Delete users for the specified tenant from a (CSV) file.post
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
Groups Management Version 2.0
This API is used to modify a group's attributes. It can be used to update one or more attributes.patch
Delete a group from a specified tenant.delete
Updates the group's attributes for a specified tenant.put
Retrieves the details of a group for a specified tenant.get
Retrieves the total number of groups under a tenant in the Cloud Directory.get
Creates a group for a specified tenant.post
Retrieves a list of groups that belong to the specified tenant and match the search criteria.get
Import groups for the specified tenant from a comma separated value (CSV) file.post
User Self Care API
Validates the authentication attempt that is associated with the current step in the username recovery flow.post
Recover the user's forgotten user name.put
Initiate a forgot username request by using an authentication mechanism.post
Validates the authentication attempt that is associated with the current step in the reset password flow.post
Reset the user's forgotten password.put
Initiate a reset password request by using an authentication mechanism.post

Attribute management
Attributes
Reverts a global attribute to the default configurationput
Modifies selected properties of an attributepatch
Deletes an attributedelete
Modifies an attributeput
Gets an attributeget
Gets the list of existing attribute tagsget
Bulk management operations of attributespatch
Creates an attributepost
Lists all attributesget
Retrieves the list of attribute functions that are configured for the specified tenantget

Application management
Application Access
API to determine if a user is entitled to an application.post
Fetches the applications that are entitled to a user.get
Gets all operations performed in an Account Sync operationget
Get All account synchronization status for all applications of given tenant.get
Updates entitlements to an application.post
Fetches the entitlements of an application.get
Updates the attributes of an application accessible to the owner.put
Fetches the details of an application accessible to owner.get
Searches for the applications of an owner.get
Retrieves a list of application ids that have the specified auth policy id attached.get
Provides mechanism to adopt an Orphan accountpost
Retrieves all supporting data for a given application.get
Gets the Application account list details for specified account synchronization id.get
Stop given account synchronization of an application.post
Gets adoption stats details of account synchronization for an application.get
Get Last run reconciliation status for an application.get
Start / Stop Account Synchronization.post
Suspend/Restore/Orphan/Unmanage/deprovision an Account identified by this applicationId, userId.post
Get attribute values delta for an account for the application.get
Get the account attributes of given account associated with an application.get
Remediate Non-Compliant accounts for an application.post
Gets the list of accounts for the specified application.get
Deletes the application that is specified by the application ID.delete
Updates an application.put
Gets the details of an application.get
Gets the summary stats of all applications for a given tenant.get
Update custom rule.put
Get rule definition.get
Create custom rule.post
Checks if the identity source is configured with an application.get
Creates an instance of an application for a tenant.post
Gets the list of all applications that were onboarded by tenant administrator.get
Retry a failed operationpost
Gets details of the specified operationget
Retry a list of failed operations.post
Gets the list of all the operations that are performed on accounts of this tenant.get
Entitlement Management
Get the right values of a permission assigned to a user.get
Get the entitlements that are granted to a user.get
Get all the applications that are granted to a user.get
Check if a user is granted to an application.post
Check if a user is granted to an application.get
Get the entitlements granted to the logged user.get
Get the entitlements granted to a group.get
Publish or discard an entitlement.patch
Update the rights values of a role.patch
Add or remove one or more children for an entitlement.post
Find the children of an entitlement.get
Update an entitlement.patch
Delete an entitlement.delete
Grant or revoke an entitlement to one or more users and groups.post
Get the entitlement details.get
Grant or revoke one or more entitlements to a user.post
Search the entitlements.post
Get the list of user added to or removed from dynamic entitlement.post
Grant or revoke one or more entitlements to a group.post
Search the assignments.post
Creates a new entitlement.post
Update the rights values of an assignment.patch
Get the rights values associated to an assignment.get

Authentication
Identity Sources
Delete an identity source instance of the tenant with the specified instance ID.delete
Update an identity source instance of the tenant with the specified instance ID.put
Retrieve the details of a particular identity source instance of the tenant with the specified instance ID.get
Retrieve all the identity source instances of the tenant that have this property name and value.get
Retrieve all the identity source instances of the tenant that use the passord policy ID's specified in the 'search' query parameter.get
Create an identity source instance for a tenant.post
Retrieve all the identity source instances of the tenant.get
Identity Source Types
Retrieve the metadata of a particular SAML Enterprise.get
Retrieve the details of a particular identity source types.get
Retrieve the details of all the identity source types.get
Authentication Token Exchange
Exchange a valid bearer token for an authenticated browser sessionget
Authentication Manage User Sessions
Delete random session for the user.delete
Social JWT Exchange
Exchange a valid social JWT for an IBM Security Verify access token.post
FIDO Configuration
Delete a relying party configuration.delete
Update a relying party configuration.put
Retrieve a relying party configuration.get
Create a relying party configuration.post
Retrieve the list of relying party configurations.get
Delete a metadata entry.delete
Update a metadata entry.put
Retrieve a metadata entry.get
Create a metadata entry.post
Retrieve the list of metadata entries.get
QR Code Login Configuration
Update the QR code login configuration.put
Retrieve the QR code login configuration.get
reCAPTCHA
Delete a reCAPTCHA configurationdelete
Update a reCAPTCHA configurationput
Retrieve a reCAPTCHA configurationget
Create a reCAPTCHA configurationpost
Retrieve the list of reCAPTCHA configurationsget
FIDO
Complete a FIDO registration.post
Initiate a FIDO registration.post
Complete a FIDO authentication.post
Initiate a FIDO authentication.post
Resolve an rpId.post
Delete a FIDO registration.delete
Update a FIDO registration.put
Retrieve a FIDO registration.get
Retrieve the list of FIDO registrations.get
QR Code Login
Cancel a QR code login verification.delete
Attempt a QR code login verification.post
Retrieve a QR code login verification.get
Create a QR code login verification.get
Password Authentication
Reset a user's password for an identity source.post
Attempt password authentication with an identity source.post
Change a user's password for an identity source.put
Retrieve the list of valid password based identity sources.get

Multi-factor authentication
Authentication Factors 2.0
Discover the availability of an authentication factor.get
Discover the availability of all authentication factors.get
Retrieve the list of authentication factor enrollments.get
Email One-time Password 2.0
Cancel a email one-time password verification.delete
Attempt a email one-time password verification.post
Retrieve a email one-time password verification.get
Create a email one-time password verification.post
Delete a email one-time password enrollment.delete
Update a email one-time password enrollment.put
Retrieve a email one-time password enrollment.get
Cancel a transient email one-time password verification.delete
Attempt a transient email one-time password verification.post
Retrieve a transient email one-time password verification.get
Create a transient email one-time password verification.post
Create a email one-time password enrollment.post
Retrieve the list of email one-time password enrollments.get
One-time Password
Cancel a one-time password verification.delete
Attempt a one-time password verification.post
Retrieve a one-time password verification.get
Create a one-time password verification.post
Knowledge Questions
Delete a knowledge question verification.delete
Attempt a knowledge question verification.post
Retrieve a knowledge question verification.get
Create a knowledge question verification.post
Delete a knowledge question enrollment.delete
Update a knowledge question enrollment.put
Retrieve a knowledge question enrollment.get
Create a knowledge question enrollment.post
Retrieve the list of knowledge question enrollments.get
SMS One-time Password 2.0
Cancel a SMS one-time password verification.delete
Attempt a SMS one-time password verification.post
Retrieve a SMS one-time password verification.get
Create a SMS one-time password verification.post
Delete a SMS one-time password enrollment.delete
Update a SMS one-time password enrollment.put
Retrieve a SMS one-time password enrollment.get
Cancel a transient SMS one-time password verification.delete
Attempt a transient SMS one-time password verification.post
Retrieve a transient SMS one-time password verification.get
Create a transient SMS one-time password verification.post
Create a SMS one-time password enrollment.post
Retrieve the list of SMS one-time password enrollments.get
Time-based One-time Password 2.0
Delete a time-based one-time password enrollment.delete
Attempt a time-based one-time password verification.post
Update a time-based one-time password enrollment.put
Retrieve a time-based one-time password enrollment.get
Create a time-based one-time password enrollment.post
Retrieve the list of time-based one-time password enrollments.get
Voice One-time Password
Cancel a voice one-time password verification.delete
Attempt a voice one-time password verification.post
Retrieve a voice one-time password verification.get
Create a voice one-time password verification.post
Delete a voice one-time password enrollment.delete
Update a voice one-time password enrollment.put
Retrieve a voice one-time password enrollment.get
Cancel a transient voice one-time password verification.delete
Attempt a transient voice one-time password verification.post
Retrieve a transient voice one-time password verification.get
Create a transient voice one-time password verification.post
Create a voice one-time password enrollment.post
Retrieve the list of voice one-time password enrollments.get
Authenticators
Complete a specific verification transaction.post
Retrieve a specific verification transaction.get
Initiate a verification transaction.post
Retrieve the list of verification transactions.get
Update the editable attributes of a specific authenticator registration.patch
Delete a specific authenticator registration.delete
Update the editable attributes of a specific authenticator registration.put
Retrieve a specific authenticator registration.get
Complete or refresh an authenticator registration.post
Initiate an authenticator registration.post
Retrieve the list of available authenticator clients.get
Retrieve the list of registered authenticators.get
Signature Authentication
Update the editable attributes of a specific signature enrollment.patch
Delete a specific signature enrollment.delete
Update the editable attributes of a specific signature enrollment.put
Retrieve a specific signature enrollment.get
Enroll a signature authentication method.post
Retrieve the list of signature enrollments.get

Federation
Identity Provider Attribute Mappings
Set the global attribute mappings for identity sources.put
Retrieve the global configuration for attribute mapping that can be overridden in individual identity providers.get
OpenID Connect Grant Management
Deletes a specific OIDC grant.delete
Retrieves a specific OIDC grant.get
Bulk delete, disable, or enable OIDC grants.patch
Retrieves the list of OIDC grants.get
Deletes a specific OIDC grant.delete
Retrieves a specific OIDC grant.get
Bulk delete, disable, or enable OIDC grants.patch
Retrieves the list of OIDC grants.get
Deletes a specific OIDC grant.delete
Retrieves a specific OIDC grant.get
Bulk delete, disable, or enable OIDC grants.patch
Retrieves the list of OIDC grants.get
OpenID Connect Dynamic Client Profile
Update dynamic client profile.put
Read dynamic client profile.get
OpenID Connect Federation
Updates the OpenID Connect federation configuration.put
Retrieves the OpenID Connect federation configuration.get
SAML 2.0 Alias Management
Deletes a specific alias belonging to userdelete
Retrieves a specific alias belonging to userget
Retrieves the list of aliases belonging to userget
Deletes a specific aliasdelete
Retrieves a specific aliasget
Retrieves the list of aliasesget
SAML 2.0 Federations Management
Exports a federation metadataget
Update a Federationput
Get a Federationget
Get all Federationsget
WS Federation Management
Enable WS-Federation audit tracepost
Enable WS-Federation audit trace for the tenantpost

Access & Risk Policies
Access Policy Management V5.0
delete an access policy revisiondelete
update a access policy revisionput
retrieve a revision for an access policyget
retrieve the revisions for an access policyget
delete an access policydelete
create an access policy revisionpost
update a access policyput
retrieve a access policyget
create an access policypost
retrieve access policiesget

Branding & customization
Customization - Themes
Deletes a customization for a specific template file in a themedelete
Update a specific template file for a themeput
Download a specific template file from a themeget
Delete a theme registrationdelete
Update a theme registrationput
Download theme-based templatesget
Register a new themepost
List all the themesget
Reset customizationsdelete

Lifecycle & Governance
Adapter Management
Publish the profilepost
Get webui template in the system for a given profile id and template id.get
Get all profiles in system for a tenant with a given template id.get
Delete specified profiledelete
Update draft in system.put
Get details of the specified profileget
List all profiles using the attribute.get
Create draft in system.post
Get all custom profiles in system.get
Provisioning Management
Delete provisioning policy for an application.delete
Create a provisioning policy for an applicatication. Provisioning policy enables or disables publishing of provisioning events for the application.post
Update provisioning policy for an application. In addition resends all events for the application.put
Get provisioning policy for an application.get
Certification Campaign statistics
Retrieve statistics of specific assignments within a given instance.get
Retrieve statistics of specific campaign instances.get
Retrieve statistics of specific assignments.get
Retrieve statistics of specific assignments within a given instance.get
Retrieve statistics of specific campaign instances.get
Retrieve campaign statistics.get
Retrieve statistics of specific assignments.get
Certification Campaign assignments
Retrieve all assignments in a given campaign instance.post
Retrieve all assignments, in a given campaign instance.get
Modify a given set of assignments.patch
Modify a given assignment.put
Retrieve a specific assignment.get
Retrieve all assignments in a given campaign instance.post
Retrieve all assignments in a given campaign instanceget
Refresh assignments in a continuous campaign.post
Modify a given set of assignments.patch
Add new assignments to a continuous campaign instance.post
Add new assignments to a continuous campaign.post
Modify a given assignment.put
Retrieve a specific assignment.get
Certification Campaign configurations
Delete specific campaign configuration.delete
Edit specific campaign configuration.put
Retrieve a specific campaign configuration.get
Edit campaign configurations.patch
Create a campaign configuration.post
Retrieve the campaign configurations.get
Certification Campaign instances
Retrieve specific campaign instance.get
Retrieve campaign instances.get
Retrieve instances corresponding to a specific campaign configuration.get
Create a preview campaign.post
Modify specific campaign instance.put
Retrieve a specific campaign instance.get
Modify campaign instances.patch
Retrieve campaign instances.get
Retrieve instances corresponding to a specific campaign configuration.get
Access Request Management V1.0
Delete a workflow configuration.delete
Replace an existing workflow configuration.put
Find a workflow configuration by ID.get
Find a workflow configuration.get
Find all requestable applications in the catalog.get
Deprecated - Cancel a list of requestspost
Deprecated - Create a fine grained access request for selfpost
Deprecated - Get the summary of self request statisticsget
Deprecated - Get statistical view of self requestsget
Create a self requestpost
Deprecated - Search the self requestsget
Cancel a list of requestspost
Create a fine grained access requestspost
Send a reminder to all approvers of a requestpost
Add a justificationpost
Get request detailsget
Get the summary of request statisticsget
Get statistical view of requestsget
Create a requestpost
Search the requestsget
Execute actions for a list of requestspost
Get statistical summary of requests for approvalget
Get statistical view of requests for approvalget
Search requests of an approverget
Delete all the requests that are filtered by one or more query parameters.delete
Delete a request by iddelete
Get the requestable access list for self.post
Get details of specified requestable access.get

Identity agents
Agent Bridge Support Service
Retrieve the API Client credentials.get
Delete an agent configuration.delete
Update a specific agent configuration.put
Retrieve a specific agent's configuration.get
Retrieve corrupted agent configuration(s) which can't be decrypted due to missing certificateget
Create an agent configuration.post
Retrieve agent configurations.get

Data privacy & consent
Data Privacy and Consent
Provides the data usage approval.post
Presents the data subject information to the user.post
Bulk create or patch consent records.patch
Create or update a consent record.post
Data Privacy and Consent Management
Delete a specific consent record from a tenant.delete
Retrieve a specific consent record.get
Bulk delete consent records.patch
Retrieve a list of consent records.get

Event analytics & reports
Events
Get all events for a tenant.get
Reports
Run a report.post
Export reports for a specified tenant into CSV file.post

Authentication Configuration
Email One-time Password Configuration 2.0
Update the email one-time password configuration.put
Retrieve the email one-time password configuration.get
One-time Password Configuration 2.0
Update the one-time password configuration.put
Retrieve the one-time password configuration.get
Knowledge Questions Configuration
Update a knowledge questions configuration profile.put
Retrieve a knowledge questions configuration profile.get
Retrieve the list of knowledge questions configuration profiles.get
SMS One-time Password Configuration 2.0
Update the SMS one-time password configuration.put
Retrieve the SMS one-time password configuration.get
Time-based One-time Password Configuration 2.0
Update the time-based one-time password configuration.put
Retrieve the time-based one-time password configuration.get
Voice One-time Password Configuration
Update the voice one-time password configuration.put
Retrieve the voice one-time password configuration.get
Authenticator Clients
Update the metadata attributes of an authenticator client.patch
Update the metadata attributes of an authenticator client.put
Retrieve the metadata of a specific authenticator client.get
Update the editable attributes of a specific authenticator client.patch
Delete a specific authenticator client.delete
Update the editable attributes of a specific authenticator client.put
Retrieve a specific authenticator client.get
Create an authenticator client.post
Retrieve the list of authenticator clients.get
Signature Authentication Configuration
Update the signature authentication methods configuration.patch
Update the signature authentication method configuration.put
Retrieve the signature authentication methods configuration.get

General configuration
API Clients
Gets a YAML response that contains the credentials for a specific client.get
Deletes an API clientdelete
Updates a specific API clientput
Gets a specific API clientget
Bulk deletes the API clientspatch
Create an API Clientpost
Lists the API Clientsget
Session Exchange Configuration
Set the session exchange config.put
Retrieve the configuration for session exchange.get
Tenant Properties API 2.0
Replaces the tenant properties for the specified tenant.put
Retrieves a list of tenant properties for the specified tenant.get
Admin Entitlement Management
Find the admin entitlements that are granted to a user.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 group.get
Publish or discard an admin entitlement.patch
Add or remove one or more children for an admin entitlement.post
Get the children of an admin entitlement.get
Update an admin entitlement.patch
Delete an admin entitlement.delete
Grant or revoke an admin entitlement to one or more users and groups.post
Get an admin entitlement.get
Grant or revoke one or more admin entitlements to a user.post
Get the list of admin entitlements.post
Get the list of user added to or removed from dynamic admin entitlement.post
Grant or revoke one or more admin entitlements to a group.post
Get the list of admin assignments.post
Create an admin entitlement.post
Certificates
Delete a signer certificate.delete
Gets the signer certificate with the given label.get
Imports a signer certificate.post
Gets the list of signer certificates.get
Delete a personal certificate.delete
Update a personal certificate.put
Get a single personal certificate with the specified label.get
Import or generate a personal certificate.post
Gets the list of personal certificates.get
Push Credentials Management
Delete a specific set of configured mobile push provider credentials.delete
Update a specific set of configured mobile push provider credentials.put
Get a specific set of configured mobile push provider credentials.get
Create a set of mobile push provider credentials.post
Get all the sets of configured mobile push provider credentials.get

Password Vault
Password Vault Configuration
Update the password vault configuration.put
Retrieve the password vault configuration.get
Password Vault
Delete a password vault resource.delete
Update a password vault resource.put
Retrieve a password vault resource.get
Delete a password vault enrollment.delete
Update a password vault enrollment.put
Retrieve a password vault enrollment.get

Deprecated APIs
Deprecated - Attribute Evaluation. Replaced by /v2.0/attributequery.
Deprecated - Preview the value that would be computed for this attribute.post
Access Policy Management v3.0 (deprecated)
Deprecated - Delete custom policy of tenant with specified id.delete
Deprecated - Update the policy instance of tenant with specified id.put
Deprecated - Retrieve the details of a particular policy specified with id.get
Deprecated - Create a custom policy for tenant.post
Deprecated - Retrieve list of tenant policies.get
OpenID Connect Consent Management (deprecated)
Deprecated - Bulk scope/entitlement removal of OIDC consents.patch
Deprecated - Deletes a specific OIDC consent.delete
Deprecated - Retrieves a specific OIDC consent.get
Deprecated - Bulk delete, or scope and entitlement removal of OIDC consents.patch
Deprecated - Retrieves the list of OIDC consents.get
Deprecated - Deletes a specific OIDC consent.delete
Deprecated - Retrieves a specific OIDC consent.get
Deprecated - Bulk delete OIDC consents.patch
Deprecated - Retrieves the list of OIDC consents.get
Deprecated - Deletes a specific OIDC consent.delete
Deprecated - Retrieves a specific OIDC consent.get
Deprecated - Bulk delete, or scope and entitlement removal of OIDC consents.patch
Deprecated - Retrieves the list of OIDC consents.get
Customization - Templates (deprecated)
Deprecated - Upload Template Customizationspost
Deprecated - Download templatesget

IBM Security Verify API
Tenant policy configuration
Set the configuration for first factor policy. This is a list of policy Id, but only one policy is currently supportedput
Retrieve the configuration for first factor policy. This is a list of policy Id, but only one policy is currently supportedget
External MFA Providers
Retrieve the list of enrollments for all external MFA providers.get
Continue an authentication attempt via an external MFA provider.post
Retrieve the status of an authentication attempt.get
Clears all cached enrollments of specific user for an external MFA providerdelete
Action an authentication attempt via an external MFA provider.post
Retrieve the list of enrollments for an external MFA provider.get
Retrieve the list of external MFA providers.get
Delete an external MFA provider configuration.delete
Update an external MFA provider configuration.put
Retrieve an external MFA provider configuration.get
Create an external MFA provider configuration.post
Retrieve the list of external MFA provider configurations.get
Access Management
Find the children of an application entitlement either requestable or requested or granted to a specific user.get
Fetch the access assignments of specific user.post
Get user access assignments statistics.get
Get user access assignments in active and fulfillment failed state.post
Find the children of an entitlement either requestable or requested or granted to self.get
Device manager configuration
Lists uniqueuseridentifiersget
Deletes your own devicedelete
Lists your own device informationget
Delete user devicedelete
Lists device informationget
Test a device manager connectionput
PATCH a device manager configuration.patch
Delete a device manager configuration.delete
Update a device manager configurationput
Get a device-managerget
Get trusted certificates as a zip file.get
Test a device manager connectionpost
Create a device manager configuration.post
Lists device managersget
Smartcard and other X.509 certificate provider configuration
Update a smartcard or X.509 certificate provider with PATCHpatch
Delete a smartcard or X.509 certificate providerdelete
Update a smartcard or X.509 certificate provider.put
Get a smartcard and other X.509 certificate providersget
Lists attributes and uniqueUserIdentifiers for a X.509 compliant certificate.get
Create a smartcard and other X.509 certificate provider.post
Lists smartcard and other X.509 certificate providers.get
Smartcard or certificate provider operations
Remove smartcard/X.509 certificate provider certificates for a specified user id.delete
Webhook-Configuration
Tests a resource of a configured webhookget
Test a configured webhookget
Current webhook statusget
Get webhook healthget
Remove a dead letterdelete
Retrieve a dead letterget
Initiate a reconciliation of deadletterspost
View the state of a deadletter reconciliationget
View the total number of deadletters a webhookget
Remove webhook dead lettersdelete
Fetch webhook dead lettersget
Delete a webhhookdelete
Update a Webhookput
Fetch a Webhookget
Develop an transformpost
List Webhook Purposesget
Preflight a webhook configurationpost
Preflight a webhook configurationpost
Create a Webhookpost
List Webhooksget

400The request was incorrect.

403Forbidden.

404Not found.

500An internal server error occurred.