Introduction

Last updated: 2021-10-15

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.

Need some help getting started? Check out this video tutorial on working with the Management API.

Endpoint URLs

App ID supports region-specific endpoint URLs that you can use to interact with the service over public service 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 key 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 Shell to quickly generate a personal access token.

To generate an access token from your API key, use the following cURL command.

curl -X POST \
  "https://iam.cloud.ibm.com/identity/token" \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: application/json' \
  --data-urlencode 'grant_type=urn:ibm:params:oauth:grant-type:apikey' \
  --data-urlencode 'apikey={api_key}'

Replace {api_key} with your IBM Cloud API key. To learn more, check out the IAM docs.

Example that uses IAM authentication

curl -X {request_method} "{base_url}/api/v1/{method_endpoint}" --header "Authorization: Bearer {IAM_token}"

Replace {IAM_token} with your IBM Cloud IAM access token.

Auditing

You can monitor API activity within your account by using the IBM Cloud Activity Tracker service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker. The specific event type is listed for each individual method.

For more information about how to track App ID activity, see Auditing events for App ID.

Error handling

The App ID APIs use standard HTTP 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.

Status code summary
Status code Description
200 OK Everything worked as expected.
201 OK Everything worked as expected. No content is returned.
400 Bad Request The request was unsuccessful, often due to a missing required parameter.
401 Unauthorized The parameters were valid but the request failed due insufficient permissions.
404 Not Found The requested resource doesn't exist.
409 Conflict The requested resource conflicts with an already existing resource.
410 Gone The requested resource was deleted and no longer exists.
429 Too Many Requests Too many requests hit the API too quickly.
500 Internal Server Error Something went wrong on App ID's end.

Related APIs

Don't see the API endpoint that you're looking for? Check out the other APIs for Authorization and authentication and Profiles.

Methods

Get Facebook IDP configuration

Returns the Facebook identity provider configuration.

GET /management/v4/{tenantId}/config/idps/facebook

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.idps

Auditing

Calling this method generates the following auditing event.

  • appid.idp-config.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

facebookConfigParams

Status Code

  • 200

    Returns a JSON object of the Facebook identity provider configuration, including the status and credentials. Learn more.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

Example responses
  • {
  "isActive": true,
  "config": {
    "idpId": "facebook_appID",
    "secret": "facebook_appsecret"
  },
  "redirectURL": "https://us-south.appid.cloud.ibm.com/oauth/v4/39a37f57-a227-4bfe-a044-93b6e6060b61/Facebook/callback"
}

Update Facebook IDP configuration

Configure Facebook to set up a single sign-on experience for your users. By using Facebook, users are able to sign in with credentials with which they are already familiar. Learn more.

PUT /management/v4/{tenantId}/config/idps/facebook

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.idps

Auditing

Calling this method generates the following auditing event.

  • appid.idp-config.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
facebookGoogleConfigParams

The identity provider configuration as a JSON object. If the configuration is not set, IBM default credentials are used.

Response

Response Body

facebookConfigParamsPUT

Status Code

  • 200

    The Facebook configuration was updated. Returns a JSON object of the idp data.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

Example responses
  • {
  "isActive": true,
  "config": {
    "idpId": "facebook_appID",
    "secret": "facebook_appsecret"
  }
}

Get Google IDP configuration

Returns the Google identity provider configuration.

GET /management/v4/{tenantId}/config/idps/google

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.idps

Auditing

Calling this method generates the following auditing event.

  • appid.idp-config.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

googleConfigParams

Status Code

  • 200

    Returns a JSON object of the Google identity provider configuration, including the status and credentials. Learn more.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

Example responses
  • {
  "isActive": true,
  "config": {
    "idpId": "google_appID",
    "secret": "google_appsecret"
  },
  "redirectURL": "https://us-south.appid.cloud.ibm.com/oauth/v4/39a37f57-a227-4bfe-a044-93b6e6060b61/Google/callback"
}

Update Google IDP configuration

Configure Google to set up a single sign-on experience for your users. By using Google, users are able to sign in with credentials with which they are already familiar. Learn more.

PUT /management/v4/{tenantId}/config/idps/google

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.idps

Auditing

Calling this method generates the following auditing event.

  • appid.idp-config.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
facebookGoogleConfigParams

The identity provider configuration as a JSON object. If the configuration is not set, IBM default credentials are used.

Response

Response Body

googleConfigParamsPUT

Status Code

  • 200

    The Google configuration was updated. Returns a JSON object of the idp data.

  • 400

    The tenantId or request body is missing or invalid. The tenantId can be found in the service credentials.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

Example responses
  • {
  "isActive": true,
  "config": {
    "idpId": "google_appID",
    "secret": "google_appsecret"
  }
}

Get IBMid IDP configuration

Returns the IBMid identity provider configuration.

GET /management/v4/{tenantId}/config/idps/ibmid

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.idps

Auditing

Calling this method generates the following auditing event.

  • appid.idp-config.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

ibmidConfigParams

Status Code

  • 200

    Returns a JSON object of the IBMid identity provider configuration, including the status and credentials.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

No Sample Response

This method does not specify any sample responses.

Update IBMid IDP configuration

Configure IBMid to set up a single sign-on experience for your users.

PUT /management/v4/{tenantId}/config/idps/ibmid

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.idps

Auditing

Calling this method generates the following auditing event.

  • appid.idp-config.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
ibmidConfigParams

The identity provider configuration as a JSON object. If the configuration is not set, IBM default credentials are used.

Response

Response Body

ibmidConfigParamsPUT

Status Code

  • 200

    The IBMid configuration was updated. Returns a JSON object of the idp data.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

Example responses
  • {
  "isActive": true,
  "config": {
    "idpId": "client_id",
    "secret": "client_secret",
    "preProd": false,
    "ciBased": true
  },
  "redirectURL": "https://example.com"
}

Get Custom identity configuration

GET /management/v4/{tenantId}/config/idps/custom

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.idps

Auditing

Calling this method generates the following auditing event.

  • appid.idp-config.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

customIdPConfigParams

Status Code

  • 200

    Returns a JSON object of the Custom identity configuration containing the PEM public key and the isActive status.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

Example responses
  • {
  "isActive": true,
  "config": {
    "publicKey": "-----BEGIN RSA PUBLIC KEY-----u0mGFYvwLArEZNrK5SBwd...vPeBHF3Kq2xDfvhTBsl79j-----END RSA PUBLIC KEY-----"
  }
}

Update Custom identity configuration

Configure App ID Custom identity to allow users to sign-in using your own identity provider.

PUT /management/v4/{tenantId}/config/idps/custom

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.idps

Auditing

Calling this method generates the following auditing event.

  • appid.idp-config.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
customIdPConfigParams

The identity provider configuration as a JSON object.

Examples:
View

Response

Response Body

customIdPConfigParams

Status Code

  • 200

    The Custom identity configuration was updated. Returns a JSON object of the updated configuration.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

Example responses
  • {
  "isActive": true,
  "config": {
    "publicKey": "-----BEGIN RSA PUBLIC KEY-----u0mGFYvwLArEZNrK5SBwd...vPeBHF3Kq2xDfvhTBsl79j-----END RSA PUBLIC KEY-----"
  }
}

Get Cloud Directory IDP configuration

Returns the Cloud Directory identity provider configuration. Learn more.

GET /management/v4/{tenantId}/config/idps/cloud_directory

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.idps

Auditing

Calling this method generates the following auditing event.

  • appid.idp-config.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

cloudDirectoryResponse

Status Code

  • 200

    Returns a JSON object of the Cloud Directory identity provider configuration, including the status and credentials.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

Example responses
  • {
  "isActive": true,
  "config": {
    "selfServiceEnabled": true,
    "signupEnabled": true,
    "interactions": {
      "identityConfirmation": {
        "accessMode": "FULL",
        "methods": [
          "email"
        ]
      },
      "welcomeEnabled": false,
      "resetPasswordEnabled": false,
      "resetPasswordNotificationEnable": true
    },
    "identityField": "email"
  }
}

Update Cloud Directory IDP configuration

Configure Cloud Directory to set up a single sign-on experience for your users. With Cloud Directory users can use their email and a password of their choice to log in to your applications. Learn more.

PUT /management/v4/{tenantId}/config/idps/cloud_directory

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.idps

Auditing

Calling this method generates the following auditing event.

  • appid.idp-config.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
object

The identity provider configuration as a JSON object. If the configuration is not set, IBM default credentials are used.

Response

Response Body

cloudDirectoryResponse

Status Code

  • 200

    The Cloud Directory configuration was updated. Returns a JSON object of the idp data.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

Example responses
  • {
  "isActive": true,
  "config": {
    "selfServiceEnabled": true,
    "signupEnabled": true,
    "interactions": {
      "identityConfirmation": {
        "accessMode": "FULL",
        "methods": [
          "email"
        ]
      },
      "welcomeEnabled": false,
      "resetPasswordEnabled": false,
      "resetPasswordNotificationEnable": true
    },
    "identityField": "email"
  }
}

Get SAML IDP configuration

Returns the SAML identity provider configuration, including status and credentials. Learn more.

GET /management/v4/{tenantId}/config/idps/saml

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.idps

Auditing

Calling this method generates the following auditing event.

  • appid.idp-config.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

samlResponse

Status Code

  • 200

    Returns the identity provider configuration for SAML as a JSON object.

  • 400

    The tenantId or request body is missing or invalid. The tenantId can be found in the service credentials.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

Example responses
  • {
  "isActive": true,
  "config": {
    "entityID": "https://example.com/saml2/metadata/706634",
    "signInUrl": "https://example.com/saml2/sso-redirect/706634",
    "certificates": [
      "certificate-example-pem-format"
    ],
    "displayName": "my saml example",
    "authnContext": {
      "class": [
        "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport"
      ],
      "comparison": "exact"
    },
    "signRequest": false,
    "encryptResponse": false
  }
}

Update SAML IDP configuration

Configure SAML to set up a single sign-on experience for your users. Learn more.

PUT /management/v4/{tenantId}/config/idps/saml

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.idps

Auditing

Calling this method generates the following auditing event.

  • appid.idp-config.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
object

The identity provider configuration as a JSON object.

Response

Response Body

samlResponseWithValidationData

Status Code

  • 200

    The SAML configuration was updated. Returns a JSON object of the idp data.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

Example responses
  • {
  "isActive": true,
  "config": {
    "entityID": "https://example.com/saml2/metadata/706634",
    "signInUrl": "https://example.com/saml2/sso-redirect/706634",
    "certificates": [
      "certificate-example-pem-format"
    ],
    "displayName": "my saml example",
    "authnContext": {
      "class": [
        "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport"
      ],
      "comparison": "exact"
    },
    "signRequest": false,
    "encryptResponse": false
  },
  "validation_data": {
    "certificates": [
      {
        "certificate_index": 0,
        "expiration_timestamp": 1674473996,
        "warning": "Your certificate will expire in 18 days."
      }
    ]
  }
}

Get tokens configuration

Returns the token configuration. Learn more.

GET /management/v4/{tenantId}/config/tokens

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.tokens-config.read

Auditing

Calling this method generates the following auditing event.

  • appid.mgmt.get.tokens.configuration

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

tokensConfigResponse

Status Code

  • 200

    Returns a JSON object of the App ID tokens properties.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "idTokenClaims": [
    {
      "source": "attributes",
      "sourceClaim": "theme"
    }
  ],
  "accessTokenClaims": [
    {
      "source": "saml",
      "sourceClaim": "user_type",
      "destinationClaim": "type"
    }
  ],
  "access": {
    "expires_in": 3600
  },
  "refresh": {
    "expires_in": 2592000,
    "enabled": true
  },
  "anonymousAccess": {
    "expires_in": 2592000,
    "enabled": true
  }
}

Update tokens configuration

Update the tokens' configuration to fine-tune the expiration times of access, id and refresh tokens, to enable/disable refresh and anonymous tokens, and to configure custom claims. When a token config object is not included in the set, its value will be reset back to default. Learn more.

PUT /management/v4/{tenantId}/config/tokens

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.tokens.configuration

Auditing

Calling this method generates the following auditing event.

  • appid.tokens-config.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
tokensConfigResponse

Set of App ID token objects. 'expires_in' is set in seconds.

Examples:
View

Response

Response Body

tokensConfigResponse

Status Code

  • 200

    The token configuration was updated.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "idTokenClaims": [
    {
      "source": "attributes",
      "sourceClaim": "theme"
    }
  ],
  "accessTokenClaims": [
    {
      "source": "saml",
      "sourceClaim": "user_type",
      "destinationClaim": "type"
    }
  ],
  "access": {
    "expires_in": 3600
  },
  "refresh": {
    "expires_in": 2592000,
    "enabled": true
  },
  "anonymousAccess": {
    "expires_in": 2592000,
    "enabled": true
  }
}

Get redirect URIs

Returns the list of the redirect URIs that can be used as callbacks of App ID authentication flow. Learn more.

GET /management/v4/{tenantId}/config/redirect_uris

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.redirect.uris

Auditing

Calling this method generates the following auditing event.

  • appid.redirect-uris.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

redirectUriResponse

Status Code

  • 200

    An array of the redirect URIs is returned as a JSON object.

  • 400

    The tenantId parameter is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "redirectUris": [
    "https://example.com/oauth-callback"
  ]
}

Update redirect URIs

Update the list of the redirect URIs that can be used as callbacks of App ID authentication flow. Learn more.

PUT /management/v4/{tenantId}/config/redirect_uris

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.redirect.uris

Auditing

Calling this method generates the following auditing event.

  • appid.redirect-uris.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
redirectUriConfig

The redirect URIs JSON object. If IBM default credentials are used, the redirect URIs are ignored.

Response

Status Code

  • 204

    No content. The redirect URIs were updated.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

No Sample Response

This method does not specify any sample responses.

Get user profiles configuration

A user profile is an entity that is stored and maintained by App ID. The profile holds a user's attributes and identity. It can be anonymous or linked to an identity that is managed by an identity provider. Learn more.

GET /management/v4/{tenantId}/config/users_profile

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.user.profile.config

Auditing

Calling this method generates the following auditing event.

  • appid.is-profiles-active.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

object

Status Code

  • 200

    The current profiles status is returned as a JSON object.

  • 400

    The tenantId is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

Example responses
  • {
  "isActive": false
}

Update user profiles configuration

A user profile is an entity that is stored and maintained by App ID. The profile holds a user's attributes and identity. It can be anonymous or linked to an identity that is managed by an identity provider. Learn more.

PUT /management/v4/{tenantId}/config/users_profile

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.user.profile.config

Auditing

Calling this method generates the following auditing event.

  • appid.is-profiles-active.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
profiles

Store user profile data. It can be enabled or disabled.

Response

Status Code

  • 204

    No content. The user profiles status was updated.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The has insufficient permissions. Contact the service owner or admin to verify permissions.

No Sample Response

This method does not specify any sample responses.

Get widget texts

Get the theme texts of the App ID login widget. Learn more.

GET /management/v4/{tenantId}/config/ui/theme_text

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.ui.config

Auditing

Calling this method generates the following auditing event.

  • appid.theme-color.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

object

Status Code

  • 200

    The current color configuration is returned as a JSON object.

  • 400

    The tenantId is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

Example responses
  • {
  "tabTitle": "Login",
  "footnote": "Powered by App ID"
}

Update widget texts

Update the texts of the App ID login widget. Learn more.

PUT /management/v4/{tenantId}/config/ui/theme_text

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.ui.config

Auditing

Calling this method generates the following auditing event.

  • appid.theme-text.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
themeTextConfigParam

The texts of the widget.

Response

Status Code

  • 204

    No content, the service login widget header color was updated.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

No Sample Response

This method does not specify any sample responses.

Get widget colors

Get the colors of the App ID login widget. Learn more.

GET /management/v4/{tenantId}/config/ui/theme_color

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.ui.config

Auditing

Calling this method generates the following auditing event.

  • appid.theme-color.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

object

Status Code

  • 200

    The current color configuration is returned as a JSON object.

  • 400

    The tenantId is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

Example responses
  • {
  "headerColor": "#EEF2F5"
}

Update widget colors

Update the colors of the App ID login widget. Learn more.

PUT /management/v4/{tenantId}/config/ui/theme_color

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.ui.config

Auditing

Calling this method generates the following auditing event.

  • appid.theme-color.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
themeColorConfigParam

The colors of the widget.

Response

Status Code

  • 204

    No content, the service login widget header color was updated.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

No Sample Response

This method does not specify any sample responses.

Delete widget logo

You can delete the image file shown in the login widget. Learn more.

DELETE /management/v4/{tenantId}/config/ui/media

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Query Parameters

  • mediaType
    Required*
    string

    The type of media. You can upload JPG or PNG files.

    Allowable values: [logo]

Response

Status Code

  • 204

    The logo was deleted.

  • 400

    The tenantId or file type are missing.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

No Sample Response

This method does not specify any sample responses.

Get widget logo

Returns the link to the custom logo image of the login widget. Learn more.

GET /management/v4/{tenantId}/config/ui/media

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.ui.config

Auditing

Calling this method generates the following auditing event.

  • appid.media.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

object

Status Code

  • 200

    A JSON object with the current media configurations.

  • 400

    The tenantId, file type, or file size are invalid or missing. The file must be either a JPG or PNG that is less than 100kb.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

Example responses
  • {
  "image": "image-url"
}

Update widget logo

You can update the image file shown in the login widget. Learn more.

POST /management/v4/{tenantId}/config/ui/media

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.ui.config

Auditing

Calling this method generates the following auditing event.

  • appid.media.update

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Query Parameters

  • mediaType
    Required*
    string

    The type of media. You can upload JPG or PNG files.

    Allowable values: [logo]

Form Parameters

  • file
    Required*
    binary

    The image file. The recommended size is 320x320 px. The maxmimum files size is 100kb.

Response

Status Code

  • 204

    No content. The service login widget logo was updated.

  • 400

    The tenantId, file type, or file size are invalid or missing. The file must be either a JPG or PNG that is less than 100kb.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

No Sample Response

This method does not specify any sample responses.

Get the SAML metadata

Returns the SAML metadata required in order to integrate App ID with a SAML identity provider. Learn more.

GET /management/v4/{tenantId}/config/saml_metadata

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.saml.metadata

Auditing

Calling this method generates the following auditing event.

  • appid.saml-metadata.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

string

Status Code

  • 200

    An xml snippet that contains the metadata for using SAML as a service provider.

  • 400

    The tenantId parameter is missing or invalid.

  • 500

    Returned in case of internal server error.

Example responses
  • <SPSSODescriptor WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</NameIDFormat><AssertionConsumerService index="1" isDefault="true" Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://us-south.appid.cloud.ibm.com/saml2/v1/login-acs"/></SPSSODescriptor>

Get an email template

Returns the content of a custom email template or the default template in case it wasn't customized. Learn more.

GET /management/v4/{tenantId}/config/cloud_directory/templates/{templateName}/{language}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.email.template

Auditing

Calling this method generates the following auditing event.

  • appid.email-template.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

  • templateName
    Required*
    string

    The type of email template. This can be "USER_VERIFICATION", "WELCOME", "PASSWORD_CHANGED", "RESET_PASSWORD" or "MFA_VERIFICATION".

    Allowable values: [USER_VERIFICATION,RESET_PASSWORD,WELCOME,PASSWORD_CHANGED,MFA_VERIFICATION]

  • language
    Required*
    string

    Preferred language for resource. Format as described at RFC5646. According to the configured languages codes returned from the GET /management/v4/{tenantId}/config/ui/languages API.

Response

Response Body

getTemplate

Status Code

  • 200

    The email template data is returned as a JSON object. If the language template does not exist yet the english template (en) will be returned.

  • 400

    The tenantId or templateName are missing or invalid or language is not in the app localization configuration.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

Example responses
  • {
  "subject": "Verify Your Email for %{user.displayName}",
  "html_body": "<h3>Hello %{user.displayName}</h3>\\n<p>Follow this link to verify your email address</p>\\n<p><a href='%{verify.link}'>%{verify.link}</a></p>\\n<p>If you didn't ask to verify this address, you can ignore this email</p>\\n<p>Thanks,</p>\\n<p>Your BMLand team</p>",
  "base64_encoded_html_body": "PGgzPkhlbGxvICV7dXNlci5kaXNwbGF5TmFtZX08L2gzPlxuPHA+Rm9sbG93IHRoaXMgbGluayB0byB2ZXJpZnkgeW91ciBlbWFpbCBhZGRyZXNzPC9wPlxuPHA+PGEgaHJlZj0nJXt2ZXJpZnkubGlua30nPiV7dmVyaWZ5Lmxpbmt9PC9hPjwvcD5cbjxwPklmIHlvdSBkaWRuJ3QgYXNrIHRvIHZlcmlmeSB0aGlzIGFkZHJlc3MsIHlvdSBjYW4gaWdub3JlIHRoaXMgZW1haWw8L3A+XG48cD5UaGFua3MsPC9wPlxuPHA+WW91ciBCTUxhbmQgdGVhbTwvcD4="
}

Update an email template

Updates the Cloud Directory email template. Learn more.

PUT /management/v4/{tenantId}/config/cloud_directory/templates/{templateName}/{language}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.email.template

Auditing

Calling this method generates the following auditing event.

  • appid.email-template.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

  • templateName
    Required*
    string

    The type of email template. This can be "USER_VERIFICATION", "WELCOME", "PASSWORD_CHANGED", "RESET_PASSWORD" or "MFA_VERIFICATION".

    Allowable values: [USER_VERIFICATION,RESET_PASSWORD,WELCOME,PASSWORD_CHANGED,MFA_VERIFICATION]

  • language
    Required*
    string

    Preferred language for resource. Format as described at RFC5646. According to the configured languages codes returned from the GET /management/v4/{tenantId}/config/ui/languages API.

Request Body

Required*
setTemplate

Email template object. See documentation for available placeholder for each email template.

  • subject: The subject of the email.
  • html_body: Optional. The HTML body of the email.
  • base64_encoded_html_body: Optional. The HTML body of the email encoded in Base64.
  • plain_text_body: Optional. The text body of the email.
Examples:
View

Response

Response Body

getTemplate

Status Code

  • 200

    The email template properties is returned as a JSON object.

  • 201

    The created email template properties are returned as a JSON object.

  • 204

    No content. The template configuration was updated.(in case request Prefer header is return_minimal)

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized.

  • 403

    The user has insufficient permissions.

Example responses
  • {
  "subject": "Verify Your Email for %{user.displayName}",
  "html_body": "<h3>Hello %{user.displayName}</h3>\\n<p>Follow this link to verify your email address</p>\\n<p><a href='%{verify.link}'>%{verify.link}</a></p>\\n<p>If you didn't ask to verify this address, you can ignore this email</p>\\n<p>Thanks,</p>\\n<p>Your BMLand team</p>",
  "base64_encoded_html_body": "PGgzPkhlbGxvICV7dXNlci5kaXNwbGF5TmFtZX08L2gzPlxuPHA+Rm9sbG93IHRoaXMgbGluayB0byB2ZXJpZnkgeW91ciBlbWFpbCBhZGRyZXNzPC9wPlxuPHA+PGEgaHJlZj0nJXt2ZXJpZnkubGlua30nPiV7dmVyaWZ5Lmxpbmt9PC9hPjwvcD5cbjxwPklmIHlvdSBkaWRuJ3QgYXNrIHRvIHZlcmlmeSB0aGlzIGFkZHJlc3MsIHlvdSBjYW4gaWdub3JlIHRoaXMgZW1haWw8L3A+XG48cD5UaGFua3MsPC9wPlxuPHA+WW91ciBCTUxhbmQgdGVhbTwvcD4="
}
  • {
  "subject": "Verify Your Email for %{user.displayName}",
  "html_body": "<h3>Hello %{user.displayName}</h3>\\n<p>Follow this link to verify your email address</p>\\n<p><a href='%{verify.link}'>%{verify.link}</a></p>\\n<p>If you didn't ask to verify this address, you can ignore this email</p>\\n<p>Thanks,</p>\\n<p>Your BMLand team</p>",
  "base64_encoded_html_body": "PGgzPkhlbGxvICV7dXNlci5kaXNwbGF5TmFtZX08L2gzPlxuPHA+Rm9sbG93IHRoaXMgbGluayB0byB2ZXJpZnkgeW91ciBlbWFpbCBhZGRyZXNzPC9wPlxuPHA+PGEgaHJlZj0nJXt2ZXJpZnkubGlua30nPiV7dmVyaWZ5Lmxpbmt9PC9hPjwvcD5cbjxwPklmIHlvdSBkaWRuJ3QgYXNrIHRvIHZlcmlmeSB0aGlzIGFkZHJlc3MsIHlvdSBjYW4gaWdub3JlIHRoaXMgZW1haWw8L3A+XG48cD5UaGFua3MsPC9wPlxuPHA+WW91ciBCTUxhbmQgdGVhbTwvcD4="
}

Delete an email template

Delete the customized email template and reverts to App ID default template. Learn more.

DELETE /management/v4/{tenantId}/config/cloud_directory/templates/{templateName}/{language}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.delete.email.template

Auditing

Calling this method generates the following auditing event.

  • appid.email-template.delete

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

  • templateName
    Required*
    string

    The type of email template. This can be "USER_VERIFICATION", "WELCOME", "PASSWORD_CHANGED", "RESET_PASSWORD" or "MFA_VERIFICATION".

    Allowable values: [USER_VERIFICATION,RESET_PASSWORD,WELCOME,PASSWORD_CHANGED,MFA_VERIFICATION]

  • language
    Required*
    string

    Preferred language for resource. Format as described at RFC5646. According to the configured languages codes returned from the GET /management/v4/{tenantId}/config/ui/languages API.

Response

Status Code

  • 204

    The template was deleted.

  • 400

    The tenantId is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact a service owner or admin to verify permissions.

  • 404

    The template does not exist.

No Sample Response

This method does not specify any sample responses.

Get languages

Returns the list of languages that can be used to customize email templates for Cloud Directory

GET /management/v4/{tenantId}/config/ui/languages

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.ui.config

Auditing

Calling this method generates the following auditing event.

  • appid.ui-languages.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

getLanguages

Status Code

  • 200

    The localization data is returned as a JSON object.

  • 400

    The tenantId or languages are missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

Example responses
  • {
  "languages": [
    "en",
    "en-US",
    "fr-FR"
  ]
}

Update languages

Update the list of languages that can be used to customize email templates for Cloud Directory

PUT /management/v4/{tenantId}/config/ui/languages

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.ui.config

Auditing

Calling this method generates the following auditing event.

  • appid.ui-languages.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

getLanguages

User localization configuration. Available languages codes

Examples:
View

Response

Status Code

  • 204

    'No content. The localization configuration was updated.'

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

No Sample Response

This method does not specify any sample responses.

Get sender details

Returns the sender details configuration that is used by Cloud Directory when sending emails. Learn more.

GET /management/v4/{tenantId}/config/cloud_directory/sender_details

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.sender.details.cd

Auditing

Calling this method generates the following auditing event.

  • appid.sender-details.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

cloudDirectorySenderDetails

Status Code

  • 200

    The sender details configuration for a Cloud Directory email returned as a JSON object.

  • 400

    The tenantId parameter is missing or invalid or invalid request.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "senderDetails": {
    "from": {
      "name": "no-reply",
      "email": "no-reply@appid.cloud.net"
    },
    "reply_to": {
      "name": "Reply-to",
      "email": "reply-to@example.com"
    },
    "linkExpirationSec": 86400
  }
}

Update the sender details

Updates the sender details configuration that is used by Cloud Directory when sending emails. Learn more.

PUT /management/v4/{tenantId}/config/cloud_directory/sender_details

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.sender.details.cd

Auditing

Calling this method generates the following auditing event.

  • appid.sender-details.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
cloudDirectorySenderDetails

A JSON object that contains the sender details.

Examples:
View

Response

Status Code

  • 204

    No content. The identity provider configuration was updated.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

No Sample Response

This method does not specify any sample responses.

Get action url

Get the custom url to redirect to when action is executed. Learn more.

GET /management/v4/{tenantId}/config/cloud_directory/action_url/{action}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.cd.action.url

Auditing

Calling this method generates the following auditing event.

  • appid.action-url.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

  • action
    Required*
    string

    The type of the action. on_user_verified - the URL of your custom user verified page, on_reset_password - the URL of your custom reset password page.

    Allowable values: [on_user_verified,on_reset_password]

Response

Response Body

actionUrlResponse

Status Code

  • 200

    The action URL that is returned as a JSON object.

  • 400

    The tenantId or action parameters are invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "actionUrl": "https://example.com/myCustomPage"
}

Update action url

Updates the custom url to redirect to when action is executed. Learn more.

PUT /management/v4/{tenantId}/config/cloud_directory/action_url/{action}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.cd.action.url

Auditing

Calling this method generates the following auditing event.

  • appid.action-url.update

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

  • action
    Required*
    string

    The type of the action. on_user_verified - the URL of your custom user verified page, on_reset_password - the URL of your custom reset password page.

    Allowable values: [on_user_verified,on_reset_password]

Form Parameters

  • actionUrl
    Required*
    string

    The action URL.

Response

Response Body

actionUrlResponse

Status Code

  • 200

    The action url.

  • 400

    The tenantId or action parameters are invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "actionUrl": "https://example.com/myCustomPage"
}

Delete action url

Delete the custom url to redirect to when action is executed. Learn more.

DELETE /management/v4/{tenantId}/config/cloud_directory/action_url/{action}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.del.cd.action.url

Auditing

Calling this method generates the following auditing event.

  • appid.action-url.delete

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

  • action
    Required*
    string

    The type of the action. on_user_verified - the URL of your custom user verified page, on_reset_password - the URL of your custom reset password page.

    Allowable values: [on_user_verified,on_reset_password]

Response

Status Code

  • 204

    No content. The action url was deleted.

  • 400

    The tenantId or action parameters are invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact a service owner or admin to verify permissions.

  • 404

    The template does not exist.

No Sample Response

This method does not specify any sample responses.

Get password regex

Returns the regular expression used by App ID for password strength validation. Learn more.

GET /management/v4/{tenantId}/config/cloud_directory/password_regex

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.cd.password.policy

Auditing

Calling this method generates the following auditing event.

  • appid.password-regex.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

passwordRegexConfigParamsGet

Status Code

  • 200

    Returns a JSON object of defined regex expression escaped rule for acceptable password, base64 encoded regex expression and custom error message.

  • 400

    The tenantId is invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "base64_encoded_regex": "LipbYS16XS4q",
  "error_message": "The password must contain at least 1 lowercase alphabetical character",
  "regex": ".*[a-z].*"
}

Update password regex

Updates the regular expression used by App ID for password strength validation. For example, the regular expression: `"^[A-Za-z\d]*$"`` should be passed as:

{
  "base64_encoded_regex": "XltBLVphLXpcZF0qJA==",
  "error_message": "Must only contain letters and digits"
}

Learn more.

PUT /management/v4/{tenantId}/config/cloud_directory/password_regex

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.cd.password.policy

Auditing

Calling this method generates the following auditing event.

  • appid.password-regex.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
passwordRegexConfigParams

The Cloud Directory password regex configuration as a JSON object. If the configuration is not set, IBM App ID basic password regex is used.

  • regex: Optional. The escaped regex expression rule for acceptable password.
  • base64_encoded_regex: Optional. The regex expression rule for acceptable password encoded in base64.
  • error_message: Custom error message.
Examples:
View

Response

Response Body

passwordRegexConfigParamsGet

Status Code

  • 200

    The password regex was updated.

  • 400

    The tenantId or password regex parameters are invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "base64_encoded_regex": "LipbYS16XS4q",
  "error_message": "The password must contain at least 1 lowercase alphabetical character",
  "regex": ".*[a-z].*"
}

Get email dispatcher configuration

Get the configuration of email dispatcher that is used by Cloud Directory when sending emails

GET /management/v4/{tenantId}/config/cloud_directory/email_dispatcher

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.cd.get.email.dispatcher

Auditing

Calling this method generates the following auditing event.

  • appid.email-dispatcher.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

emailDispatcherParams

Status Code

  • 200

    Return the email dispatcher configuration.

  • 400

    The tenantId is invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "provider": "sendgrid",
  "sendgrid": {
    "apiKey": "sendgridApiKey"
  },
  "custom": {
    "url": "https://custom_email_dispatcher.com/send",
    "authorization": {
      "type": "value",
      "value": "verySecureSecret"
    }
  }
}

Update email dispatcher configuration

App ID allows you to use your own email provider. You can use your own Sendgrid account by providing your Sendgrind API key. Alternatively, you can define a custom email dispatcher by providing App ID with URL. The URL is called for sending emails. Optionally, you can determine a specific authorization method – either basic, such as a username and password, or a custom value. By default, App ID's email provider will be used.

PUT /management/v4/{tenantId}/config/cloud_directory/email_dispatcher

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.cd.set.email.dispatcher

Auditing

Calling this method generates the following auditing event.

  • appid.email-dispatcher.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
emailDispatcherParams

The Cloud Directory email dispatcher configuration, specified as a JSON object.

Examples:
View

Response

Response Body

emailDispatcherParams

Status Code

  • 200

    The email dispatcher was updated.

  • 400

    The tenantId or custom email dispatcher config are invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "provider": "sendgrid",
  "sendgrid": {
    "apiKey": "sendgridApiKey"
  },
  "custom": {
    "url": "https://custom_email_dispatcher.com/send",
    "authorization": {
      "type": "value",
      "value": "verySecureSecret"
    }
  }
}

Test the email provider configuration

You can send a message to a specific email to test your settings.

POST /management/v4/{tenantId}/config/cloud_directory/email_settings/test

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.cd.post.email.dispatcher.test

Auditing

Calling this method generates the following auditing event.

  • appid.email-settings-test.send

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
emailSettingsTestParams

Email dispatcher settings, specified as a JSON object.

Examples:
View

Response

Response Body

respEmailSettingsTest

Status Code

  • 200

    Returns the response status code and additional information from the email provider in case of failure.

  • 400

    The tenantId or are invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "success": true,
  "dispatcherStatusCode": 202
}

Test the email dispatcher configuration

You can send a message to a specific email to test your configuration.

POST /management/v4/{tenantId}/config/cloud_directory/email_dispatcher/test

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.cd.post.email.dispatcher.test

Auditing

Calling this method generates the following auditing event.

  • appid.email-dispatcher-test.send

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Form Parameters

  • email
    Required*
    string

    The email address where you want to send your test message.

Response

Response Body

respCustomEmailDisParams

Status Code

  • 200

    Returns the response status code and headers from the custom email dispatcher.

  • 400

    The tenantId or email value are invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "statusCode": 400,
  "headers": {
    "server": "nginx",
    "date": "Tue, 24 Jul 2018 09:50:25 GMT",
    "content-type": "application/json",
    "access-control-allow-headers": "Authorization, Content-Type"
  }
}

Test the MFA SMS dispatcher configuration

You can send a message to a specific phone number to test your MFA SMS configuration.

POST /management/v4/{tenantId}/config/cloud_directory/sms_dispatcher/test

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.cd.post.sms.dispatcher.test

Auditing

Calling this method generates the following auditing event.

  • appid.sms-dispatcher-test.send

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
smsDispatcherTest

The phone number where you want to send your test SMS message.

Response

Response Body

respSMSDisParams

Status Code

  • 200

    Returns the response status code and headers from the SMS dispatcher.

  • 400

    The tenantId or SMS channel configuration is invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "confirmationCode": 979469,
  "phoneNumber": "+1-999-999-9999"
}

Get APM configuration

Get the configuration of the advanced password management.

GET /management/v4/{tenantId}/config/cloud_directory/advanced_password_management

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.advanced.password.management

Auditing

Calling this method generates the following auditing event.

  • appid.advanced-password-management.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

apmSchema

Status Code

  • 200

    Return the advanced password management configuration.

  • 400

    The tenantId is invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "advancedPasswordManagement": {
    "enabled": true,
    "passwordReuse": {
      "enabled": true,
      "config": {
        "maxPasswordReuse": 8
      }
    },
    "preventPasswordWithUsername": {
      "enabled": true
    },
    "passwordExpiration": {
      "enabled": true,
      "config": {
        "daysToExpire": 30
      }
    },
    "lockOutPolicy": {
      "enabled": true,
      "config": {
        "lockOutTimeSec": 1800,
        "numOfAttempts": 3
      }
    },
    "minPasswordChangeInterval": {
      "enabled": true,
      "config": {
        "minHoursToChangePassword": 0
      }
    }
  }
}

Update APM configuration

Updates the advanced password management configuration for the provided tenantId. By turning this on, any authentication event is also charged as advanced security event.

PUT /management/v4/{tenantId}/config/cloud_directory/advanced_password_management

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.set.advanced.password.management

Auditing

Calling this method generates the following auditing event.

  • appid.advanced-password-management.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
apmSchema

The Cloud Directory APM configuration, specified as a JSON object.

Examples:
View

Response

Response Body

apmSchema

Status Code

  • 200

    The advanced password management configuration was updated.

  • 400

    The tenantId or advanced password management configuration are invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "advancedPasswordManagement": {
    "enabled": true,
    "passwordReuse": {
      "enabled": true,
      "config": {
        "maxPasswordReuse": 8
      }
    },
    "preventPasswordWithUsername": {
      "enabled": true
    },
    "passwordExpiration": {
      "enabled": true,
      "config": {
        "daysToExpire": 30
      }
    },
    "lockOutPolicy": {
      "enabled": true,
      "config": {
        "lockOutTimeSec": 1800,
        "numOfAttempts": 3
      }
    },
    "minPasswordChangeInterval": {
      "enabled": true,
      "config": {
        "minHoursToChangePassword": 0
      }
    }
  }
}

Get tenant audit status

Returns a JSON object containing the auditing status of the tenant.

GET /management/v4/{tenantId}/config/capture_runtime_activity

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.capture.runtime.activity

Auditing

Calling this method generates the following auditing event.

  • appid.capture-runtime-activity.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

object

Status Code

  • 200

    Returns a JSON object containing the auditing status of the tenant.

  • 400

    The tenantId is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

Example responses
  • {
  "isActive": true
}

Update tenant audit status

Capture app user sign-in, sign-up and other runtime events in Activity Tracker for you to search, analyze and report. By turning this On, any authentication event is also charged as advanced security event. Activity Tracker is available in select regions. Learn more.

PUT /management/v4/{tenantId}/config/capture_runtime_activity

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.capture.runtime.activity

Auditing

Calling this method generates the following auditing event.

  • appid.capture-runtime-activity.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
object

The new audit status, specified as a JSON object.

Response

Status Code

  • 204

    The tenant was updated.

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

No Sample Response

This method does not specify any sample responses.

Get channels

Returns all MFA channels registered with the App ID Instance.

GET /management/v4/{tenantId}/config/cloud_directory/mfa/channels

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.mfa.channels

Auditing

Calling this method generates the following auditing event.

  • appid.mfa-channels.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

getAllMfaChannels

Status Code

  • 200

    Returns a JSON object of all the MFA channels registered with the App ID tenant

  • 400

    The tenantId is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

Example responses
  • {
  "channels": [
    {
      "isActive": true,
      "type": "email"
    },
    {
      "isActive": false,
      "type": "sms",
      "config": {
        "key": "key",
        "secret": "secret",
        "from": 1234567890,
        "provider": "nexmo"
      }
    }
  ]
}

Get channel

Returns a specific MFA channel registered with the App ID Instance.

GET /management/v4/{tenantId}/config/cloud_directory/mfa/channels/{channel}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.mfa.channel

Auditing

Calling this method generates the following auditing event.

  • appid.mfa-channel.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

  • channel
    Required*
    string

    The MFA channel.

    Allowable values: [email,nexmo]

Response

Response Body

getSMSChannel

Status Code

  • 200

    Returns a specific channel registered with the App ID tenant as a JSON object

  • 400

    The tenantId is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

Example responses
  • [
  {
    "isActive": false,
    "type": "sms",
    "config": {
      "key": "key",
      "secret": "secret",
      "from": "1234567890",
      "provider": "nexmo"
    }
  }
]

Update channel

Enable or disable a registered MFA channel on the App ID instance.

PUT /management/v4/{tenantId}/config/cloud_directory/mfa/channels/{channel}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.mfa.channel

Auditing

Calling this method generates the following auditing event.

  • appid.mfa-channel.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

  • channel
    Required*
    string

    The MFA channel.

    Allowable values: [email,nexmo]

Request Body

Required*
updateMfaChannel

Update MFA channel payload.

Response

Response Body

getSMSChannel

Status Code

  • 200

    A JSON object with the updated channel data

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 404

    The channel could not be found.

  • 500

    Returned in case of internal server error.

Example responses
  • [
  {
    "isActive": false,
    "type": "sms",
    "config": {
      "key": "key",
      "secret": "secret",
      "from": "1234567890",
      "provider": "nexmo"
    }
  }
]

Get an extension configuration

View a registered extension's configuration for an instance of App ID. Learn more.

GET /management/v4/{tenantId}/config/cloud_directory/mfa/extensions/{name}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.webhook.config

Auditing

Calling this method generates the following auditing event.

  • appid.mfa-extension.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

  • name
    Required*
    string

    The name of the extension.

    Allowable values: [premfa,postmfa]

Response

Response Body

updateExtensionConfig

Status Code

  • 200

    A JSON object that contains the extension configuration.

  • 400

    The tenant ID or request body is either missing or invalid.

  • 401

    The request is unauthorized. Be sure that you pass a valid IAM token in the authorization header of your request.

  • 403

    You have insufficient permissions. Contact your administrator or service owner to verify your permissions.

  • 500

    Internal server error. Try again in a few minutes.

Example responses
  • {
  "isActive": true,
  "config": {
    "url": "https://example.com/extension",
    "headers": {
      "authorization": "Bearer <token>"
    }
  }
}

Update an extension configuration

Set or update a registered extension's configuration for an instance of App ID. Learn more.

PUT /management/v4/{tenantId}/config/cloud_directory/mfa/extensions/{name}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.webhook.config

Auditing

Calling this method generates the following auditing event.

  • appid.mfa-extension.update

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

  • name
    Required*
    string

    The name of the extension.

    Allowable values: [premfa,postmfa]

Request Body

Required*
updateExtensionConfig

Update extension configuration payload.

Examples:
View

Response

Response Body

updateExtensionConfig

Status Code

  • 200

    A JSON object that contains either true or false, depending on your configuration.

  • 400

    The tenant ID or request body is either missing or invalid.

  • 401

    The request is unauthorized. Be sure that you pass a valid IAM token in the authorization header of your request.

  • 403

    You have insufficient permissions. Contact your administrator or service owner to verify your permissions.

  • 500

    Internal server error. Try again in a few minutes.

Example responses
  • {
  "isActive": true,
  "config": {
    "url": "https://example.com/extension",
    "headers": {
      "authorization": "Bearer <token>"
    }
  }
}

Enable or disable an extension

Update the status of a registered extension for an instance of App ID to enabled or disabled. Learn more.

PUT /management/v4/{tenantId}/config/cloud_directory/mfa/extensions/{name}/active

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.webhook.active

Auditing

Calling this method generates the following auditing event.

  • appid.is-mfa-extension-active.update

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

  • name
    Required*
    string

    The name of the extension.

    Allowable values: [premfa,postmfa]

Request Body

Required*
extensionActive

Update extension enabled.

Examples:
View

Response

Response Body

extensionActive

Status Code

  • 200

    A JSON object that contains either true or false, depending on your configuration.

  • 400

    The tenant ID or request body is either missing or invalid.

  • 401

    The request is unauthorized. Be sure that you pass a valid IAM token in the authorization header of your request.

  • 403

    You have insufficient permissions. Contact your administrator or service owner to verify your permissions.

  • 500

    Internal server error. Try again in a few minutes.

Example responses
  • {
  "isActive": true
}

Test the extension configuration

Test an extension configuration. Learn more.

POST /management/v4/{tenantId}/config/cloud_directory/mfa/extensions/{name}/test

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.test.webhook.config

Auditing

Calling this method generates the following auditing event.

  • appid.mfa-extension-test.send

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

  • name
    Required*
    string

    The name of the extension.

    Allowable values: [premfa,postmfa]

Response

Response Body

extensionTest

Status Code

  • 200

    The response status code as well as the response body and headers from the extension's URL.

  • 400

    The tenant ID or extension name are missing or invalid.

  • 401

    The request is unauthorized. Be sure that you pass a valid IAM token in the authorization header of your request.

  • 403

    You have insufficient permissions. Contact your administrator or service owner to verify your permissions.

Example responses
  • {
  "statusCode": 200,
  "responseBody": {
    "skipMfa": true
  },
  "responseHeaders": {
    "content-type": "application/json",
    "date": "Tue, 24 Jul 2018 09:50:25 GMT"
  }
}

Get MFA configuration

Returns MFA configuration registered with the App ID Instance.

GET /management/v4/{tenantId}/config/cloud_directory/mfa

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.mfa.config

Auditing

Calling this method generates the following auditing event.

  • appid.mfa.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

getMFAConfiguration

Status Code

  • 200

    Returns MFA configuration registered with the App ID tenant as a JSON object

  • 400

    The tenantId is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

Example responses
  • {
  "isActive": true
}

Update MFA configuration

Update MFA configuration on the App ID instance.

PUT /management/v4/{tenantId}/config/cloud_directory/mfa

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.mfa.config

Auditing

Calling this method generates the following auditing event.

  • appid.mfa.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
updateMfaConfig

Update MFA configuration payload.

Examples:
View

Response

Response Body

getMFAConfiguration

Status Code

  • 200

    A JSON object with the updated MFA configuration data

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

Example responses
  • {
  "isActive": true
}

Get SSO configuration

Returns SSO configuration registered with the App ID Instance.

GET /management/v4/{tenantId}/config/cloud_directory/sso

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.sso.config

Auditing

Calling this method generates the following auditing event.

  • appid.sso.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

object

Status Code

  • 200

    Returns SSO configuration registered with the App ID tenant as a JSON object

  • 400

    The tenantId is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify permissions.

Example responses
  • {
  "isActive": true,
  "inactivityTimeoutSeconds": 86400,
  "logoutRedirectUris": [
    "http://localhost:3000/logout-callback"
  ]
}

Update SSO configuration

Update SSO configuration on the App ID instance.

PUT /management/v4/{tenantId}/config/cloud_directory/sso

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.sso.config

Auditing

Calling this method generates the following auditing event.

  • appid.sso.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
updateSSOConfig

Update SSO configuration payload.

Response

Response Body

object

Status Code

  • 201

    A JSON object with the updated SSO configuration data

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 500

    Returned in case of internal server error.

Example responses
  • {
  "isActive": true,
  "inactivityTimeoutSeconds": 86400,
  "logoutRedirectUris": [
    "http://localhost:3000/logout-callback"
  ]
}

Get the rate limit configuration

Returns the rate limit configuration registered with the App ID Instance.

GET /management/v4/{tenantId}/config/cloud_directory/rate_limit

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.get.cd.rate.config

Auditing

Calling this method generates the following auditing event.

  • appid.rate-limit.read

Request

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Response

Response Body

object

Status Code

  • 200

    Returns the rate limit configuration registered with the App ID tenant as a JSON object

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "signUpLimitPerMinute": 50,
  "signInLimitPerMinute": 60
}

Update the rate limit configuration

Update the rate limit configuration on the App ID instance.

PUT /management/v4/{tenantId}/config/cloud_directory/rate_limit

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.update.cd.rate.config

Auditing

Calling this method generates the following auditing event.

  • appid.rate-limit.update

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Request Body

Required*
updateRateLimitConfig

Update rate limit configuration payload.

Response

Response Body

object

Status Code

  • 201

    A JSON object with the updated rate limit configuration data

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

Example responses
  • {
  "signUpLimitPerMinute": 50,
  "signInLimitPerMinute": 60
}

Sign up

Start the sign up process Learn more.

POST /management/v4/{tenantId}/cloud_directory/sign_up

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • appid.mgmt.cd.sign.up

Auditing

Calling this method generates the following auditing event.

  • appid.self-sign-up.start

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/x-www-form-urlencoded,multipart/form-data]

Path Parameters

  • tenantId
    Required*
    string

    The service tenantId. The tenantId can be found in the service credentials.

Query Parameters

  • shouldCreateProfile
    Required*
    boolean

    A boolean indication if a profile should be created for the Cloud Directory user.

  • language
    string

    Preferred language for resource. Format as described at RFC5646.

    Default: en

Request Body

Required*
createNewUser

Store Cloud Directory user data.

Response

Response Body

object

Status Code

  • 201

    A JSON object with the new Cloud Directory user data. Full user data can be found here: https://tools.ietf.org/html/rfc7643#section-8.2

  • 400

    The tenantId or request body is missing or invalid.

  • 401

    The user is unauthorized. To be authorized, a user needs an IAM token with the valid permissions.

  • 403

    The user has insufficient permissions. Contact the service owner or admin to verify user permissions.

  • 409

    The email address already exist.

Example responses
  • {
  "displayName": "John Doe",
  "active": true,
  "emails": [
    {
      "value": "johndoe@example.com",
      "primary": true
    }
  ],
  "meta": {
    "created": "2019-05-29T12:45:30.671Z",
    "lastModified": "2019-05-29T12:45:30.671Z",
    "resourceType": "User"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "name": {
    "givenName": "John",
    "familyName": "Doe",
    "formatted": "John Doe"
  },
  "id": "66ad3522-2251-4531-abff-3e3aad66b650"
}