API Credentials

The API Credentials page provides you with ability to create a unique set of API credentials for users assigned the Admin Role in MXO .

MXO APIs use OAuth 2.0 authentication for security. API credentials are required when using OAuth 2.0 authentication. Therefore, you must create API credentials to use the MXO APIs. Only users with the Admin role can access the API Credentials page and create API credentials for other users.

API credentials generated for a user apply on a tenancy-wide basis. Deleting a user from a Space does not delete their API credentials. Those credentials remain valid for any other Spaces to which that user has access in the same tenancy. To prevent a user from accessing the APIs, you must delete their API credentials completely.

Important: Generating credentials lets the API "run as" the user selected when generating those credentials. For this reason, we recommend creating an API user with the minimum permissions required for the intended integration.

Generate API Credentials for a User

  1. On the API Credentials page, click Add.
  2. Provide the following details:
    FieldDescription
    APIName for the credentials you are creating. For example, you may want to name the credentials after the client for which you are creating those credentials.
    UserSelect the name of the user these credentials will let you "run as" when accessing APIs.
  3. Click Generate.

To use the API Credentials when requesting an OAuth 2.0 Access Token

  1. Click the View Credentials icon for the user for whom you want to view API Credentials.
  2. Copy and paste the Client ID and Client Secret credentials into the relevant fields in your preferred API client.

Delete API Credentials for a User

  1. On the API Credentials page, click the Delete icon next to the API credentials you want to delete.
  2. Click Delete to confirm.

Using OAuth 1.0 Credentials

You'll need to know your OAuth 1.0 credentials when defining the initialization parameters for the Mobile SDKs. You can view those credentials on the API Credentials page.

  • To view your OAuth 1.0 credentials, click View OAuth 1.0 Credentials.

AS - View OAuth 1 Creds

For more information, see Integrate the iOS SDK for MXO with your App and Integrate the Android SDK for MXO with your App.