Create a new OAuth2.0 client.

Client apps are created dynamically, the only parameter required to create a new client app with Tyk is to specify the redirect URI, this is used as part of the client authentication and cannot be edited later. Please note that if you don’t attach a policy to the OAuth client you will need to provide dynamic key rules to client authorization endpoint.

POST /api/apis/oauth/{apiId}

Try it

Create a new OAuth2.0 client.

cURL

curl --request POST \
  --url https://{tenant}/api/apis/oauth/{apiId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_id": "<string>",
  "api_model": {},
  "client_id": "<string>",
  "client_name": "<string>",
  "description": "<string>",
  "meta_data": "<unknown>",
  "policy_id": "<string>",
  "redirect_uri": "<string>",
  "secret": "<string>"
}
'

200

{
  "client_id": "<string>",
  "client_name": "<string>",
  "dcr_registration": {
    "access_token": "<string>",
    "client_uri": "<string>",
    "provider": "<string>"
  },
  "description": "<string>",
  "meta_data": {},
  "policy_id": "<string>",
  "redirect_uri": "<string>",
  "secret": "<string>"
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Path Parameters

apiId · string · required

The API’s ID.

Body

application/json

api_id · string

api_model · object

client_id · string

client_name · string

description · string

meta_data · any

policy_id · string

redirect_uri · string

secret · string

Response

200

application/json

Client created.

client_id · string

client_name · string

dcr_registration · object

Show child attributes

dcr_registration. access_token · string

dcr_registration. client_uri · string

dcr_registration. provider · string

description · string

meta_data · object

Show child attributes

meta_data. {key} · string

policy_id · string

redirect_uri · string

secret · string