OAuth Clients

Server

OAuth client credentials management.

List OAuth clients

GET

https://api.cineamo.com

/oauth-clients

Returns a list of OAuthClient objects. Secrets are stored hashed and never returned.

List OAuth clients › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

List OAuth clients › Responses

OAuthClient list

OAuthClient

id

integer · readOnly

userId

integer | null

name

string

redirectUris

string[]

isRevoked

boolean

isConfidential

boolean | null

plainSecret

string | null · readOnly

Plaintext client secret. Only returned once, directly after the secret was (re)generated. It is stored hashed and can never be retrieved again.

Example: 3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e

createdAt

string | null · readOnly

updatedAt

string | null · readOnly

Create an OAuth client

POST

https://api.cineamo.com

/oauth-clients

Creates an OAuthClient. The secret is generated server-side and returned once as plainSecret — it is stored hashed and can never be retrieved again.

Create an OAuth client › Request Body

OAuthClient

id

integer · readOnly

userId

integer | null

name

string

redirectUris

string[]

isRevoked

boolean

isConfidential

boolean | null

plainSecret

string | null · readOnly

Plaintext client secret. Only returned once, directly after the secret was (re)generated. It is stored hashed and can never be retrieved again.

Example: 3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e

createdAt

string | null · readOnly

updatedAt

string | null · readOnly

Create an OAuth client › Responses

OAuthClient was created

OAuthClient

id

integer · readOnly

userId

integer | null

name

string

redirectUris

string[]

isRevoked

boolean

isConfidential

boolean | null

plainSecret

string | null · readOnly

Plaintext client secret. Only returned once, directly after the secret was (re)generated. It is stored hashed and can never be retrieved again.

Example: 3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e

createdAt

string | null · readOnly

updatedAt

string | null · readOnly

POST/oauth-clients

curl https://api.cineamo.com/oauth-clients \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "userId": 12,
  "name": "web_apps_client",
  "redirectUris": [
    "https://www.cineamo.com/api/auth/callback/cineamo"
  ],
  "isRevoked": false,
  "isConfidential": true,
  "plainSecret": "3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e",
  "createdAt": "2026-04-11T04:11:22Z",
  "updatedAt": "2026-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 1,
  "userId": 12,
  "name": "web_apps_client",
  "redirectUris": [
    "https://www.cineamo.com/api/auth/callback/cineamo"
  ],
  "isRevoked": false,
  "isConfidential": true,
  "plainSecret": "3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e",
  "createdAt": "2026-04-11T04:11:22Z",
  "updatedAt": "2026-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 1,
  "userId": 12,
  "name": "web_apps_client",
  "redirectUris": [
    "https://www.cineamo.com/api/auth/callback/cineamo"
  ],
  "isRevoked": false,
  "isConfidential": true,
  "plainSecret": "3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e",
  "createdAt": "2026-04-11T04:11:22Z",
  "updatedAt": "2026-04-11T04:11:22Z"
}

json

application/json

Get an OAuth client

GET

https://api.cineamo.com

/oauth-clients/{oauthClientId}

Returns an OAuthClient object by its Id. The secret is stored hashed and never returned.

Get an OAuth client › path Parameters

oauthClientId

integer · required

Get an OAuth client › Responses

OAuthClient details

OAuthClient

id

integer · readOnly

userId

integer | null

name

string

redirectUris

string[]

isRevoked

boolean

isConfidential

boolean | null

plainSecret

string | null · readOnly

Plaintext client secret. Only returned once, directly after the secret was (re)generated. It is stored hashed and can never be retrieved again.

Example: 3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e

createdAt

string | null · readOnly

updatedAt

string | null · readOnly

Delete an OAuth client

DELETE

https://api.cineamo.com

/oauth-clients/{oauthClientId}

Deletes an OAuthClient including all access/refresh tokens and auth codes issued to it. It returns an empty response.

Delete an OAuth client › path Parameters

oauthClientId

integer · required

Delete an OAuth client › Responses

OAuthClient was deleted

No data returned

Update an OAuth client

PATCH

https://api.cineamo.com

/oauth-clients/{oauthClientId}

Updates an OAuthClient. Pass regenerateSecret: true to rotate the secret — the new plaintext is returned once as plainSecret and stored hashed.

Update an OAuth client › path Parameters

oauthClientId

integer · required

Update an OAuth client › Request Body

OAuthClient

id

integer · readOnly

userId

integer | null

name

string

redirectUris

string[]

isRevoked

boolean

isConfidential

boolean | null

plainSecret

string | null · readOnly

Plaintext client secret. Only returned once, directly after the secret was (re)generated. It is stored hashed and can never be retrieved again.

Example: 3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e

createdAt

string | null · readOnly

updatedAt

string | null · readOnly

Update an OAuth client › Responses

200

OAuthClient was updated

OAuthClient

id

integer · readOnly

userId

integer | null

name

string

redirectUris

string[]

isRevoked

boolean

isConfidential

boolean | null

plainSecret

string | null · readOnly

Plaintext client secret. Only returned once, directly after the secret was (re)generated. It is stored hashed and can never be retrieved again.

Example: 3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e

createdAt

string | null · readOnly

updatedAt

string | null · readOnly

PATCH/oauth-clients/{oauthClientId}

curl https://api.cineamo.com/oauth-clients/:oauthClientId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "userId": 12,
  "name": "web_apps_client",
  "redirectUris": [
    "https://www.cineamo.com/api/auth/callback/cineamo"
  ],
  "isRevoked": false,
  "isConfidential": true,
  "plainSecret": "3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e",
  "createdAt": "2026-04-11T04:11:22Z",
  "updatedAt": "2026-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 1,
  "userId": 12,
  "name": "web_apps_client",
  "redirectUris": [
    "https://www.cineamo.com/api/auth/callback/cineamo"
  ],
  "isRevoked": false,
  "isConfidential": true,
  "plainSecret": "3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e",
  "createdAt": "2026-04-11T04:11:22Z",
  "updatedAt": "2026-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 1,
  "userId": 12,
  "name": "web_apps_client",
  "redirectUris": [
    "https://www.cineamo.com/api/auth/callback/cineamo"
  ],
  "isRevoked": false,
  "isConfidential": true,
  "plainSecret": "3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e",
  "createdAt": "2026-04-11T04:11:22Z",
  "updatedAt": "2026-04-11T04:11:22Z"
}

json

application/json

Highlight Text Suggestions Public (Guest) Endpoints

List OAuth clients

GET

https://api.cineamo.com

/oauth-clients

Returns a list of OAuthClient objects. Secrets are stored hashed and never returned.

List OAuth clients › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

List OAuth clients › Responses

OAuthClient list

OAuthClient

id

integer · readOnly

userId

integer | null

name

string

redirectUris

string[]

isRevoked

boolean

isConfidential

boolean | null

plainSecret

string | null · readOnly

Plaintext client secret. Only returned once, directly after the secret was (re)generated. It is stored hashed and can never be retrieved again.

Example: 3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e

createdAt

string | null · readOnly

updatedAt

string | null · readOnly

Create an OAuth client

POST

https://api.cineamo.com

/oauth-clients

Creates an OAuthClient. The secret is generated server-side and returned once as plainSecret — it is stored hashed and can never be retrieved again.

Create an OAuth client › Request Body

OAuthClient

id

integer · readOnly

userId

integer | null

name

string

redirectUris

string[]

isRevoked

boolean

isConfidential

boolean | null

plainSecret

string | null · readOnly

Plaintext client secret. Only returned once, directly after the secret was (re)generated. It is stored hashed and can never be retrieved again.

Example: 3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e

createdAt

string | null · readOnly

updatedAt

string | null · readOnly

Create an OAuth client › Responses

OAuthClient was created

OAuthClient

id

integer · readOnly

userId

integer | null

name

string

redirectUris

string[]

isRevoked

boolean

isConfidential

boolean | null

plainSecret

string | null · readOnly

Plaintext client secret. Only returned once, directly after the secret was (re)generated. It is stored hashed and can never be retrieved again.

Example: 3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e

createdAt

string | null · readOnly

updatedAt

string | null · readOnly

Get an OAuth client

GET

https://api.cineamo.com

/oauth-clients/{oauthClientId}

Returns an OAuthClient object by its Id. The secret is stored hashed and never returned.

Get an OAuth client › path Parameters

oauthClientId

integer · required

Get an OAuth client › Responses

OAuthClient details

OAuthClient

id

integer · readOnly

userId

integer | null

name

string

redirectUris

string[]

isRevoked

boolean

isConfidential

boolean | null

plainSecret

string | null · readOnly

Plaintext client secret. Only returned once, directly after the secret was (re)generated. It is stored hashed and can never be retrieved again.

Example: 3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e

createdAt

string | null · readOnly

updatedAt

string | null · readOnly

Delete an OAuth client

DELETE

https://api.cineamo.com

/oauth-clients/{oauthClientId}

Deletes an OAuthClient including all access/refresh tokens and auth codes issued to it. It returns an empty response.

Delete an OAuth client › path Parameters

oauthClientId

integer · required

Delete an OAuth client › Responses

OAuthClient was deleted

No data returned

Update an OAuth client

PATCH

https://api.cineamo.com

/oauth-clients/{oauthClientId}

Updates an OAuthClient. Pass regenerateSecret: true to rotate the secret — the new plaintext is returned once as plainSecret and stored hashed.

Update an OAuth client › path Parameters

oauthClientId

integer · required

Update an OAuth client › Request Body

OAuthClient

id

integer · readOnly

userId

integer | null

name

string

redirectUris

string[]

isRevoked

boolean

isConfidential

boolean | null

plainSecret

string | null · readOnly

Plaintext client secret. Only returned once, directly after the secret was (re)generated. It is stored hashed and can never be retrieved again.

Example: 3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e

createdAt

string | null · readOnly

updatedAt

string | null · readOnly

Update an OAuth client › Responses

200

OAuthClient was updated

OAuthClient

id

integer · readOnly

userId

integer | null

name

string

redirectUris

string[]

isRevoked

boolean

isConfidential

boolean | null

plainSecret

string | null · readOnly

Plaintext client secret. Only returned once, directly after the secret was (re)generated. It is stored hashed and can never be retrieved again.

Example: 3f7a1c9e5b2d8f4a6c0e1b3d5f7a9c2e

createdAt

string | null · readOnly

updatedAt

string | null · readOnly