API Manager Guide

Back Next

Creating an OAuth 2.0 client for the API Microgateway Service

Create an OAuth 2.0 client that enables managed API consumers to invoke managed APIs for the API Microgateway Service where OAuth 2.0 authentication is enabled by using an application or service that supports token authentication.

Open the following URL template:

https://{<host>}/apimgmt/v0.4/oath/client

Where:

<host>

is the machine that hosts the Secure Agent that runs the API Microgateway Service.

Edit the values of the request body to enable the OAuth 2.0 client for API Microgateway.

In the

"name"

field, enter a name for the OAuth 2.0 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, in the

"description"

field, enter a description of the OAuth 2.0 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 -.

Optionally, in the

"accessTokenTimeout"

field, enter a timeout value in minutes for the access token.

You can enter a value from 5 through 1440. If you don't enter a timeout value, the token timeout is 60 minutes.

Invoke a POST call.

The OAuth 2.0 client is enabled for all the API Microgateway Service managed APIs in the organization that invoke an

Application Integration

process that uses basic authentication. You can view the enabled OAuth 2.0 client on the

OAuth 2.0 Clients

table on the

Authorization

tab of the