API docs by Redocly

golem (0)

Download OpenAPI specification:Download

OAuth Clients

Api will update an OAuth Client

Api will update an OAuth Client

header Parameters
Authorization
required
string
Default: Bearer

Authorization

Request Body schema: application/json

Client Request

id
string
name
string
Array of objects (clients.ScopeDTO)
Array of objects (clients.SecretDTO)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "scopes": [
    ],
  • "secrets": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "scopes": [
    ],
  • "secrets": [
    ]
}

Api to create an OAuth Client

Api will create an OAuth Client on behalf of the user/application/service

Request Body schema: application/json

Client Request

id
string
name
string
Array of objects (clients.ScopeDTO)
Array of objects (clients.SecretDTO)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "scopes": [
    ],
  • "secrets": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "scopes": [
    ],
  • "secrets": [
    ]
}

Api to fetch a Client by Id

Api will fetch a Client by Id

path Parameters
id
required
string

Client Id

header Parameters
Authorization
required
string
Default: Bearer

Authorization

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "scopes": [
    ],
  • "secrets": [
    ]
}

Delete an OAuth Client

Api will delete an OAuth Client from the system

path Parameters
id
required
string

Client Id

header Parameters
Authorization
required
string
Default: Bearer

Authorization

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "scopes": [
    ],
  • "secrets": [
    ]
}

Api to Get a list of OAuth Clients

Api will Fetch a list of OAuth Clients which can be searched by name as well as paginated

query Parameters
skip
required
integer

Skip

limit
required
integer

Limit

search
string

Search

header Parameters
Authorization
required
string
Default: Bearer

Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

OAuth Clients - Scopes

Fetch an OAuth Client's scopes

Api returns a list of scopes for a given client

path Parameters
id
required
string

Client Id

header Parameters
Authorization
required
string
Default: Bearer

Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create an OAuth Client Scope

Api will create an OAuth Client Scope

path Parameters
id
required
string

Client Id

header Parameters
Authorization
required
string
Default: Bearer

Authorization

Request Body schema: application/json

scopes

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Delete an OAuth Client Scope

Api will delete an OAuth Client Scope by id

path Parameters
id
required
string

Client Id

pid
required
string

scope Id

header Parameters
Authorization
required
string
Default: Bearer

Authorization

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Update an OAuth Client's scope

Api will update an OAuth Client's scope

path Parameters
id
required
string

Client Id

pid
required
string

scope Id

query Parameters
scopeName
required
string

Scope Name

header Parameters
Authorization
required
string
Default: Bearer

Authorization

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

OAuth Clients - Secrets

Api to fetch a list of secretIds for a client

Api will fetch a list of secretIds for a client

path Parameters
id
required
string

Client Id

header Parameters
Authorization
required
string
Default: Bearer

Authorization

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "value": "string"
}

Api to add a secret to a client's secrets list

Api will add a secret to a client's secrets list

path Parameters
id
required
string

Client Id

header Parameters
Authorization
required
string
Default: Bearer

Authorization

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "value": "string"
}

Api to delete an OAuth Client's secret

Api will delete an OAuth Client's secret

path Parameters
id
required
string

Client Id

pid
required
string

Secret Id

header Parameters
Authorization
required
string
Default: Bearer

Authorization

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "value": "string"
}

Api to regenerate an OAuth Client's secret

Api will regenerate an OAuth Client's secret

path Parameters
id
required
string

Client Id

pid
required
string

Secret Id

header Parameters
Authorization
required
string
Default: Bearer

Authorization

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "value": "string"
}

Refresh

Refresh a golem token

Refresh a golem token

header Parameters
Authorization
required
string
Default: Bearer

Authorization

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "expiresAt": 0,
  • "refreshToken": "string",
  • "tokenType": "string"
}

Tokens

Fetch an access token

Fetch an access token

Request Body schema: application/x-www-form-urlencoded
provider
string

Provider [onBehalfOf Flow]

grantType
required
string

Grant Type ['clientCredentials'||'onBehalfOf']

clientID
string

Client ID [Client Credentials Flow]

clientSecret
string

Client Secret [Client Credentials Flow]

scope
string

Scopes (comma seperated) [Client Credentials Flow]

audience
Array of strings

Audience [Client Credentials Flow]

token
string

Token [OnBehalfOf Flow]

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "expiresAt": 0,
  • "refreshToken": "string",
  • "tokenType": "string"
}