OAuthClient

Register a new OAuth client (third-party app)

POST

http://localhost:3000/api/oauth/clients

curl -X POST 'http://localhost:3000/api/oauth/clients' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "name": "Activepieces",
  "description": "string",
  "clientType": "confidential",
  "redirectUris": [
    "https://cloud.activepieces.com/redirect"
  ],
  "allowedScopes": [
    "profile",
    "email"
  ],
  "allowedGrantTypes": [
    "authorization_code"
  ],
  "pkceRequired": false,
  "accessTokenTtl": 86400,
  "refreshTokenTtl": 2592000
}'

const body = `{
  "name": "Activepieces",
  "description": "string",
  "clientType": "confidential",
  "redirectUris": [
    "https://cloud.activepieces.com/redirect"
  ],
  "allowedScopes": [
    "profile",
    "email"
  ],
  "allowedGrantTypes": [
    "authorization_code"
  ],
  "pkceRequired": false,
  "accessTokenTtl": 86400,
  "refreshTokenTtl": 2592000
}`;

const response = await fetch('http://localhost:3000/api/oauth/clients', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "name": "Activepieces",
  "description": "string",
  "clientType": "confidential",
  "redirectUris": [
    "https://cloud.activepieces.com/redirect"
  ],
  "allowedScopes": [
    "profile",
    "email"
  ],
  "allowedGrantTypes": [
    "authorization_code"
  ],
  "pkceRequired": false,
  "accessTokenTtl": 86400,
  "refreshTokenTtl": 2592000
}'''

response = requests.post(
    'http://localhost:3000/api/oauth/clients',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "name": "Activepieces",
  "description": "string",
  "clientType": "confidential",
  "redirectUris": [
    "https://cloud.activepieces.com/redirect"
  ],
  "allowedScopes": [
    "profile",
    "email"
  ],
  "allowedGrantTypes": [
    "authorization_code"
  ],
  "pkceRequired": false,
  "accessTokenTtl": 86400,
  "refreshTokenTtl": 2592000
}

Body

application/json

namestringrequired

Example

Activepieces

descriptionstring | null

clientTypestringconfidentialpublicconfidential

redirectUrisArray<string>required

Example

[
  "https://cloud.activepieces.com/redirect"
]

allowedScopesArray<string>

Example

[
  "profile",
  "email"
]

allowedGrantTypesArray<string>authorization_coderefresh_tokenclient_credentialsauthorization_code

pkceRequiredbooleanfalse

accessTokenTtlnumber[60, 604800]86400

refreshTokenTtlnumber[60, 7776000]2592000

Response

201Created

Client created. The response includes the plaintext clientSecret exactly once — store it immediately.

400Bad Request

Invalid input

Stack Overflow Website Demo