Introduction With IBM Cloud® App ID, you can secure resources and add authentication, even when you don't have a lot of security experience. By requiring users to sign in to your app, you can store user data such as preferences or information from their public social profiles that you can use to customize each experience of your app. You can more easily access the API from your code with the available SDKs for Android, iOS, Node.js, Swift, and Javascript. The client libraries that are provided by the SDKs implement best practices for using the API and reduce the amount of code that you need to write. Android client SDKhttps://github.com/ibm-cloud-security/appid-clientsdk-android iOS Swift client SDKhttps://github.com/ibm-cloud-security/appid-clientsdk-swift Node.js server SDKhttps://github.com/ibm-cloud-security/appid-serversdk-nodejs JavaScript SDKhttps://github.com/ibm-cloud-security/appid-clientsdk-js To learn more about using the SDKs, see the IBM Cloud SDK Common projecthttps://github.com/IBM/ibm-cloud-sdk-common on Github. For more information about getting started with App ID, check out the docshttps://cloud.ibm.com/docs/appid. You can more easily access the API from your code with the available SDKs for Android, iOS, Node.js, Swift, and Javascript. The client libraries that are provided by the SDKs implement best practices for using the API and reduce the amount of code that you need to write. Android client SDKhttps://github.com/ibm-cloud-security/appid-clientsdk-android iOS Swift client SDKhttps://github.com/ibm-cloud-security/appid-clientsdk-swift Node.js server SDKhttps://github.com/ibm-cloud-security/appid-serversdk-nodejs JavaScript SDKhttps://github.com/ibm-cloud-security/appid-clientsdk-js To learn more about using the SDKs, see the IBM Cloud SDK Common projecthttps://github.com/IBM/ibm-cloud-sdk-common on Github. For more information about getting started with App ID, check out the docshttps://cloud.ibm.com/docs/appid. Endpoint URLs App ID supports region-specific endpoint URLs that you can use to interact with the service over public service endpointshttps://cloud.ibm.com/docs/appid?topic=appid-regions-endpoints. To make requests to the Management API, you supply the endpoint URL that corresponds with the location where your App ID service instance resides. Endpoint URLs by location - Dallas: https://us-south.appid.cloud.ibm.com - Frankfurt: https://eu-de.appid.cloud.ibm.com - London: https://eu-gb.appid.cloud.ibm.com - Osaka: https://jp-osa.appid.cloud.ibm.com - Sao Paulo: https://br-sao.appid.cloud.ibm.com - Sydney: https://au-syd.appid.cloud.ibm.com - Tokyo: https://jp-tok.appid.cloud.ibm.com - Toronto: https://ca-tor.appid.cloud.ibm.com - Washington: https://us-east.appid.cloud.ibm.com Base URL https://{region}.appid.cloud.ibm.com Authentication This API uses token-based IBM Cloud® Identity and Access Management IAM authentication. To work with the Management APIs, you need to provide a valid IAM token in each request to the service. You can generate an IAM token by first creating an IBM Cloud API keyhttps://cloud.ibm.com/docs/account?topic=account-iamtokenfromapikey and then exchanging your API key for an IBM Cloud IAM token. Don't have an API key? Try running ibmcloud iam oauth-tokens in the IBM Cloud Shellhttps://cloud.ibm.com/shell to quickly generate a personal access token. To generate an access token from your API key, use the following cURL command. bash curl -X POST \ "https://iam.cloud.ibm.com/identity/token" \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Accept: application/json' \ --data-urlencode 'granttype=urn:ibm:params:oauth:grant-type:apikey' \ --data-urlencode 'apikey={apikey}' Replace {apikey} with your IBM Cloud API key. To learn more, check out the IAM docshttps://cloud.ibm.com/docs/account?topic=account-iamtokenfromapikey. Example that uses IAM authentication bash curl -X {requestmethod} "{baseurl}/api/v1/{methodendpoint}" --header "Authorization: Bearer {IAMtoken}" Replace {IAMtoken} with your IBM Cloud IAM access token. Auditing You can monitor API activity within your account by using the IBM Cloud Logs service. Whenever an API method is called, an event is generated that you can then track and audit from within IBM Cloud Logs. The specific event type is listed for each individual method. For more information about how to track App ID activity, see Activity tracking events for App IDhttps://cloud.ibm.com/docs/appid?topic=appid-atevents. Error handling The App ID APIs use standard HTTP status codeshttps://cloud.ibm.com/docs/api-handbook?topic=api-handbook-status-codes to indicate whether a method completed successfully. HTTP response codes in the 2xx range indicate success. A response in the 4xx range is some sort of failure, and a response in the 5xx range usually indicates an internal system error.
| Method | Path | Summary |
|---|---|---|
| GET | /management/v4/{tenantId}/config/idps/facebook | Get Facebook IDP configuration |
| PUT | /management/v4/{tenantId}/config/idps/facebook | Update Facebook IDP configuration |
| GET | /management/v4/{tenantId}/config/idps/google | Get Google IDP configuration |
| PUT | /management/v4/{tenantId}/config/idps/google | Update Google IDP configuration |
| GET | /management/v4/{tenantId}/config/idps/ibmid | Get IBMid IDP configuration |
| PUT | /management/v4/{tenantId}/config/idps/ibmid | Update IBMid IDP configuration |
| GET | /management/v4/{tenantId}/config/idps/custom | Get Custom identity configuration |
| PUT | /management/v4/{tenantId}/config/idps/custom | Update or change the configuration of the Custom identity. |
| GET | /management/v4/{tenantId}/config/idps/cloud_directory | Get Cloud Directory IDP configuration |
| PUT | /management/v4/{tenantId}/config/idps/cloud_directory | Update Cloud Directory IDP configuration |
| GET | /management/v4/{tenantId}/config/idps/saml | Get SAML IDP configuration |
| PUT | /management/v4/{tenantId}/config/idps/saml | Update SAML IDP configuration |
| GET | /management/v4/{tenantId}/config/tokens | Get tokens configuration |
| PUT | /management/v4/{tenantId}/config/tokens | Update tokens configuration |
| GET | /management/v4/{tenantId}/config/redirect_uris | Get redirect URIs |
| PUT | /management/v4/{tenantId}/config/redirect_uris | Update redirect URIs |
| GET | /management/v4/{tenantId}/config/users_profile | Get user profiles configuration |
| PUT | /management/v4/{tenantId}/config/users_profile | Update user profiles configuration |
| GET | /management/v4/{tenantId}/config/ui/theme_text | Get widget texts |
| PUT | /management/v4/{tenantId}/config/ui/theme_text | Update widget texts |
| GET | /management/v4/{tenantId}/config/ui/theme_color | Get widget colors |
| PUT | /management/v4/{tenantId}/config/ui/theme_color | Update widget colors |
| DELETE | /management/v4/{tenantId}/config/ui/media | Delete widget logo |
| GET | /management/v4/{tenantId}/config/ui/media | Get widget logo |
| POST | /management/v4/{tenantId}/config/ui/media | Update widget logo |
| GET | /management/v4/{tenantId}/config/saml_metadata | Get the SAML metadata |
| GET | /management/v4/{tenantId}/config/cloud_directory/templates/{templateName}/{language} | Get an email template |
| PUT | /management/v4/{tenantId}/config/cloud_directory/templates/{templateName}/{language} | Update an email template |
| DELETE | /management/v4/{tenantId}/config/cloud_directory/templates/{templateName}/{language} | Delete an email template |
| GET | /management/v4/{tenantId}/config/ui/languages | Get languages |
| PUT | /management/v4/{tenantId}/config/ui/languages | Update languages |
| GET | /management/v4/{tenantId}/config/cloud_directory/sender_details | Get sender details |
| PUT | /management/v4/{tenantId}/config/cloud_directory/sender_details | Update the sender details |
| GET | /management/v4/{tenantId}/config/cloud_directory/action_url/{action} | Get action url |
| PUT | /management/v4/{tenantId}/config/cloud_directory/action_url/{action} | Update action url |
| DELETE | /management/v4/{tenantId}/config/cloud_directory/action_url/{action} | Delete action url |
| GET | /management/v4/{tenantId}/config/cloud_directory/password_regex | Get password regex |
| PUT | /management/v4/{tenantId}/config/cloud_directory/password_regex | Update password regex |
| GET | /management/v4/{tenantId}/config/cloud_directory/email_dispatcher | Get email dispatcher configuration |
| PUT | /management/v4/{tenantId}/config/cloud_directory/email_dispatcher | Update email dispatcher configuration |
| POST | /management/v4/{tenantId}/config/cloud_directory/email_settings/test | Test the email provider configuration |
| POST | /management/v4/{tenantId}/config/cloud_directory/email_dispatcher/test | Test the email dispatcher configuration |
| POST | /management/v4/{tenantId}/config/cloud_directory/sms_dispatcher/test | Test the MFA SMS dispatcher configuration |
| GET | /management/v4/{tenantId}/config/cloud_directory/advanced_password_management | Get APM configuration |
| PUT | /management/v4/{tenantId}/config/cloud_directory/advanced_password_management | Update APM configuration |
| GET | /management/v4/{tenantId}/config/capture_runtime_activity | Get tenant audit status |
| PUT | /management/v4/{tenantId}/config/capture_runtime_activity | Update tenant audit status |
| GET | /management/v4/{tenantId}/config/cloud_directory/mfa/channels | Get channels |
| GET | /management/v4/{tenantId}/config/cloud_directory/mfa/channels/{channel} | Get channel |
| PUT | /management/v4/{tenantId}/config/cloud_directory/mfa/channels/{channel} | Update channel |
| GET | /management/v4/{tenantId}/config/cloud_directory/mfa/extensions/{name} | Get an extension configuration |
| PUT | /management/v4/{tenantId}/config/cloud_directory/mfa/extensions/{name} | Update an extension configuration |
| PUT | /management/v4/{tenantId}/config/cloud_directory/mfa/extensions/{name}/active | Enable or disable an extension |
| POST | /management/v4/{tenantId}/config/cloud_directory/mfa/extensions/{name}/test | Test the extension configuration |
| GET | /management/v4/{tenantId}/config/cloud_directory/mfa | Get MFA configuration |
| PUT | /management/v4/{tenantId}/config/cloud_directory/mfa | Update MFA configuration |
| GET | /management/v4/{tenantId}/config/cloud_directory/sso | Get SSO configuration |
| PUT | /management/v4/{tenantId}/config/cloud_directory/sso | Update SSO configuration |
| GET | /management/v4/{tenantId}/config/cloud_directory/rate_limit | Get the rate limit configuration |
| PUT | /management/v4/{tenantId}/config/cloud_directory/rate_limit | Update the rate limit configuration |
| POST | /management/v4/{tenantId}/cloud_directory/sign_up | Sign up |
| POST | /management/v4/{tenantId}/cloud_directory/sign_up/confirmation_result | Get signup confirmation result |
| POST | /management/v4/{tenantId}/cloud_directory/forgot_password | Forgot password |
| POST | /management/v4/{tenantId}/cloud_directory/forgot_password/confirmation_result | Forgot password confirmation result |
| POST | /management/v4/{tenantId}/cloud_directory/change_password | Change password |
| POST | /management/v4/{tenantId}/cloud_directory/resend/{templateName} | Resend user notifications |
| DELETE | /management/v4/{tenantId}/cloud_directory/remove/{userId} | Delete Cloud Directory User and Profile |
| GET | /management/v4/{tenantId}/recent_authentications | Get recent activity |
| GET | /management/v4/{tenantId}/recent_authentications_hidden | Get recent activity |
| GET | /management/v4/{tenantId}/users | Search users |
| POST | /management/v4/{tenantId}/users | Pre-register a user profile |
| GET | /management/v4/{tenantId}/users/export | Export user profiles |
| POST | /management/v4/{tenantId}/users/import | Import user profiles |
| DELETE | /management/v4/{tenantId}/users/{id} | Delete user |
| POST | /management/v4/{tenantId}/users/{id}/revoke_refresh_token | Revoke refresh token |
| GET | /management/v4/{tenantId}/users/{id}/profile | Get user profile |
| PUT | /management/v4/{tenantId}/users/{id}/profile | Update user profile |
| GET | /management/v4/{tenantId}/users/{id}/roles | Get a user's roles |
| PUT | /management/v4/{tenantId}/users/{id}/roles | Update a user's roles |
| POST | /management/v4/{tenantId}/cloud_directory/export/all | Export all Cloud Directory users |
| GET | /management/v4/{tenantId}/cloud_directory/export/status | Get the export status of all Cloud Directory users |
| GET | /management/v4/{tenantId}/cloud_directory/export/download | Download exported file of all Cloud Directory users |
| DELETE | /management/v4/{tenantId}/cloud_directory/export/download | Delete exported file of all Cloud Directory users |
| POST | /management/v4/{tenantId}/cloud_directory/import/all | Import all Cloud Directory users |
| GET | /management/v4/{tenantId}/cloud_directory/import/status | Get the import status of all Cloud Directory users |
| GET | /management/v4/{tenantId}/cloud_directory/Users | Get Cloud Directory users |
| POST | /management/v4/{tenantId}/cloud_directory/Users | Create a Cloud Directory user |
| GET | /management/v4/{tenantId}/cloud_directory/Users/{userId} | Get a Cloud Directory user |
| PUT | /management/v4/{tenantId}/cloud_directory/Users/{userId} | Update a Cloud Directory user |
| DELETE | /management/v4/{tenantId}/cloud_directory/Users/{userId} | Delete a Cloud Directory user |
| POST | /management/v4/{tenantId}/cloud_directory/Users/{userId}/sso/logout | Invalidate all SSO sessions |
| GET | /management/v4/{tenantId}/cloud_directory/export | Export Cloud Directory users |
| POST | /management/v4/{tenantId}/cloud_directory/import | Import Cloud Directory users |
| GET | /management/v4/{tenantId}/cloud_directory/{userId}/userinfo | Get Cloud Directory SCIM and Attributes |
| DELETE | /management/v4/{tenantId}/cloud_directory/Users/{userId}/mfa/totp | Delete a TOTP registration |
| GET | /management/v4/{tenantId}/roles | View all roles |
| POST | /management/v4/{tenantId}/roles | Create a role |
| GET | /management/v4/{tenantId}/roles/{roleId} | View a specific role |
| PUT | /management/v4/{tenantId}/roles/{roleId} | Update a role |
| DELETE | /management/v4/{tenantId}/roles/{roleId} | Delete a role |
| GET | /management/v4/{tenantId}/applications | Get applications |
| POST | /management/v4/{tenantId}/applications | Create application |
| GET | /management/v4/{tenantId}/applications/{clientId} | Get application |
| PUT | /management/v4/{tenantId}/applications/{clientId} | Update application |
| DELETE | /management/v4/{tenantId}/applications/{clientId} | Delete application |
| GET | /management/v4/{tenantId}/applications/{clientId}/scopes | Get application scopes |
| PUT | /management/v4/{tenantId}/applications/{clientId}/scopes | Add application scope |
| GET | /management/v4/{tenantId}/applications/{clientId}/roles | Get application roles |
| PUT | /management/v4/{tenantId}/applications/{clientId}/roles | Add application role |