Create new OAuth client

curl --request POST \
  --url https://{tenant}/tyk/oauth/clients/create \
  --header 'Content-Type: application/json' \
  --header 'X-Tyk-Authorization: <api-key>' \
  --data '
{
  "api_id": "b84fe1a04e5648927971c0557971565c",
  "client_id": "2a06b398c17f46908de3dffcb71ef87df",
  "description": "google client",
  "meta_data": {
    "user_id": "362b3fb9a1d5e4f00017226f5"
  },
  "redirect_uri": "https://httpbin.org/ip",
  "secret": "MmQwNTI5NGQtYjU0YS00NjMyLWIwZjktNTZjY2M1ZjhjYWY0"
}
'

{
  "client_id": "2a06b398c17f46908de3dffcb71ef87df",
  "description": "google client",
  "meta_data": {
    "user_id": "362b3fb9a1d5e4f00017226f5"
  },
  "redirect_uri": "https://httpbin.org/ip",
  "secret": "MmQwNTI5NGQtYjU0YS00NjMyLWIwZjktNTZjY2M1ZjhjYWY0"
}

OAuth

Create new OAuth client

Any OAuth keys must be generated with the help of a client ID. These need to be pre-registered with Tyk before they can be used (in a similar vein to how you would register your app with Twitter before attempting to ask user permissions using their API).

Creating OAuth clients with Access to Multiple APIs

New from Tyk Gateway 2.6.0 is the ability to create OAuth clients with access to more than one API. If you provide the api_id it works the same as in previous releases. If you don’t provide the api_id the request uses policy access rights and enumerates APIs from their setting in the newly created OAuth-client.

POST

tyk

oauth

clients

create

Create new OAuth client

curl --request POST \
  --url https://{tenant}/tyk/oauth/clients/create \
  --header 'Content-Type: application/json' \
  --header 'X-Tyk-Authorization: <api-key>' \
  --data '
{
  "api_id": "b84fe1a04e5648927971c0557971565c",
  "client_id": "2a06b398c17f46908de3dffcb71ef87df",
  "description": "google client",
  "meta_data": {
    "user_id": "362b3fb9a1d5e4f00017226f5"
  },
  "redirect_uri": "https://httpbin.org/ip",
  "secret": "MmQwNTI5NGQtYjU0YS00NjMyLWIwZjktNTZjY2M1ZjhjYWY0"
}
'

{
  "client_id": "2a06b398c17f46908de3dffcb71ef87df",
  "description": "google client",
  "meta_data": {
    "user_id": "362b3fb9a1d5e4f00017226f5"
  },
  "redirect_uri": "https://httpbin.org/ip",
  "secret": "MmQwNTI5NGQtYjU0YS00NjMyLWIwZjktNTZjY2M1ZjhjYWY0"
}

Authorizations

X-Tyk-Authorization

string

header

required

Api key

Body

application/json

api_id

string

Example:

"keyless"

client_id

string

Example:

"2a06b398c17f46908de3dffcb71ef87b"

description

string

Example:

"google client login"

meta_data

object

Show child attributes

policy_id

string

redirect_uri

string

Example:

"https://httpbin.org/ip"

secret

string

Example:

"MmQwNTI5NGQtYjU0YS00NjMyLWIwZjktNTZjY2M1ZjhjYWY0"

Response

Client created

api_id

string

Example:

"keyless"

client_id

string

Example:

"2a06b398c17f46908de3dffcb71ef87b"

description

string

Example:

"google client login"

meta_data

object

Show child attributes

policy_id

string

redirect_uri

string

Example:

"https://httpbin.org/ip"

secret

string

Example:

"MmQwNTI5NGQtYjU0YS00NjMyLWIwZjktNTZjY2M1ZjhjYWY0"

Get API IDs for APIS that use the specified client_id(appID) for OAuth

Invalidate OAuth refresh token

⌘I

Overview

Getting Started

Deploy Tyk

Managing APIs

Security in Tyk

Reference

Developer Support

Create new OAuth client

Creating OAuth clients with Access to Multiple APIs

Authorizations

Body

Response

Overview

Getting Started

Deploy Tyk

Managing APIs

Security in Tyk

Reference

Developer Support

Documentation Index

Authorizations

Body

Response