API Manager Guide

Back Next

Creating an OAuth 2.0 client

Create an OAuth 2.0 client that enables managed API consumers to invoke managed APIs where OAuth 2.0 authentication is enabled.

On the

Policies

page, select the

Authorization

tab.

Click

Add OAuth 2.0 Client

The

Add OAuth 20.0 Client

wizard appears.

Enter the user name and password of an organization user with the Service Consumer role and click

The

Details

step appears.

Enter a name for the client. The name is case sensitive and must be unique in the organization.

The name can contain up to 32 characters, including any letter on the ASCII table, non-Latin characters, any digit, spaces, and the special characters . _ and -. The name cannot contain any of the following characters: / " ' < > & : ~ ! @ # ; % ^ * + = { } | , \

Optionally, enter a description of the client.

The description can contain up to 1,024 characters, including any letter on the ASCII table, non-Latin characters, any digit, spaces, and the special characters . _ and -.

Enter a timeout value in minutes for the access token.

The minimum value is 5 minutes and the maximum value is 1440 minutes or 24 hours. Default is 60 minutes.

After a token times out, you cannot use it. You must regenerate the token.

Click

The

Resources

step appears.

Select managed APIs that the OAuth 2.0 client applies to using one of the following options:

All API Resources. The OAuth 2.0 client applies to all the managed APIs in the organization.

APIs and API Groups. Select managed APIs and managed API groups that the OAuth 2.0 client applies to. You can select up to 50 managed APIs and up to 10 groups.

Click

API Manager

creates the client. The

Generated Credentials

step appears.

Copy the client credentials and send them to API consumers using one of the following methods:

Click

Copy

next to

OAuth 2.0 Client ID

and

OAuth 2.0 Client Secret

to copy the credentials as plain text. API consumers use the client credentials in applications and software packages where you enter each detail separately.

You cannot copy the client secret after you exit the wizard.

Click

Copy Basic Authorization Header Value

to copy the credentials as an authorization header value. API consumers use the value in applications and software packages where you enter the client credentials as a value in a Basic authorization header. For example, if the value you copy is 4879857439857349857, API consumers enter the following authorization header:

Basic 4879857439857349857

You can't use the

DOCTYPE

header in XML attachments.

Click

Finish

On the

Authorization

tab, click

Copy URL

and send the OAuth 2.0 server URL to API consumers.

OAuth 2.0 authentication and authorization