Important: Effective December 1, 2020, the other API client type is deprecated and no longer available as an option when you create a new API client. Existing API clients that use this type will continue to work. AppDirect recommends that you migrate existing API clients that use this type to another API client type. See Create API clients or Edit API clients for more information.
Marketplace Managers can create API clients that are design to ensure compatibility with existing APIs. When selecting the client type in step 4 in the following procedure, the option is named Other. AppDirect recommends that users create new API clients using only the four other API client types when creating a new API client. See Create API clients for web server applications, Create API clients for single page web applications, Create API clients for native applications and Create API clients for non-interactive applications for information on the recommended client types.
Note: The following procedure can no longer be completed after December 1, 2020. See API clients for a description of other options.
To create other API clients
Note: If the AppDirect logo appears in the upper-left corner of the page, when Manage > Marketplace appears in this topic, click the grid icon > Switch to | Store, instead.
If you set OAuth 2.0 to Enable, grant type fields appear. Select at least one grant type from the following list:
(Optional) If OAuth 2.0 is set to Enable and you selected Authorization Code, Implicit or Password (or any combination of these), Allowed Scopes (Permissions) fields appear. The selections you make here define what the API client can do and what resources it can access. Manage any of the following scopes as required:
OpenID Connect scopes—Allows an API client to verify the identity of an end user using the OpenID Connect protocol. Select one of the following:
System-level scopes—Defines if this client should be granted read only or read and write access.
See Scopes to learn more.
If OAuth 2.0 is set to Enable and you selected Authorization Code, Implicit or Password, Client Credentials (or any combination of these), the Requested Scopes Policy section opens, with a Require API Clients to Request Scopes setting. This setting is enabled by default for all new API clients. When this recommended setting is enabled, the marketplace no longer returns access tokens with all allowed scopes, when no scopes are requested by the API client.
Note: To ensure compatibility with previously created API clients, this setting is disabled for all existing API clients. API developers of existing integrations are encouraged to update their integrations with the new setting enabled, thereby requiring the API client to request specific scopes they need. To disable this setting, clear the checkbox.
(Optional) Allowed IP Addresses. Configure a comma-separated list of IP addresses from which this API client is allowed to send requests. Leave blank to allow all IP addresses. CIDR notation is supported.
Copy the Consumer Secret, then paste it in a file where you can retrieve it later as needed.
Note: If you cannot locate the Consumer Secret, you can regenerate it. See Edit API clients to learn more.