OAuth Applications

Download schema

List registered OAuth applications.

GET

https://api.stackinternal.com

/v1/oauth-applications

Paginated. Sort by client ID, name, redirect URIs, or scopes.

List registered OAuth applications. › query Parameters

page

integer · int32

Default: 1

pageSize

integer · int32

Default: 20

sort

OAuthApplicationSortField · enum

Fields the OAuth application list can be sorted by.

Enum values:

clientId

name

redirectUris

scopes

direction

SortDirection · enum

Sort order: ascending or descending.

Enum values:

asc

desc

scopes

string[]

Optional scope filter, repeatable. Returns applications requesting any of the given scopes; matching is case-insensitive. Omit to return all applications.

List registered OAuth applications. › Responses

200

A page of the workspace OAuth applications, with the total count across all pages.

OAuthApplicationsListResponse

array | null

page

integer · int32

pageSize

integer · int32

totalCount

integer · int64

Register a new OAuth application.

POST

https://api.stackinternal.com

/v1/oauth-applications

Returns the created application, including its generated client ID. Requested scopes are validated against the scope catalogue and the call is rejected if any is unknown.

Register a new OAuth application. › Request Body

The full definition of an OAuth application: sent on both create and replace.

OAuthApplicationRequest

name

string | null

description

string | null

redirectUris

array | null

scopes

array | null

Register a new OAuth application. › Responses

200

A registered OAuth application, including its generated client ID.

OAuthApplicationResponse

id

string | null

clientId

string | null

name

string | null

description

string | null

redirectUris

array | null

scopes

array | null

createdAt

string · date-time

updatedAt

string · date-time

POST/v1/oauth-applications

curl https://api.stackinternal.com/v1/oauth-applications \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "description": "description",
  "redirectUris": [
    "string"
  ],
  "scopes": [
    "string"
  ]
}'

Example Request Body

{
  "name": "name",
  "description": "description",
  "redirectUris": [
    "string"
  ],
  "scopes": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "clientId": "clientId",
  "name": "name",
  "description": "description",
  "redirectUris": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

text

List the scopes an OAuth application can request.

GET

https://api.stackinternal.com

/v1/oauth-applications/scope-options

List the scopes an OAuth application can request. › Responses

200

OAuthApplicationScopeOptionResponse[]

A scope an OAuth application may request, as offered in the workspace scope catalogue.

OAuthApplicationScopeOptionResponse

slug

string | null

name

string | null

description

string | null

resourceTypeSlug

string | null

system

boolean

Retrieve a single OAuth application.

GET

https://api.stackinternal.com

/v1/oauth-applications/{applicationId}

Returns the application's full configuration: client ID, name, description, redirect URIs, scopes, and its creation and last-updated timestamps.

Retrieve a single OAuth application. › path Parameters

applicationId

string · required

The application's identifier, as returned by the list endpoint.

Retrieve a single OAuth application. › Responses

200

A registered OAuth application, including its generated client ID.

OAuthApplicationResponse

id

string | null

clientId

string | null

name

string | null

description

string | null

redirectUris

array | null

scopes

array | null

createdAt

string · date-time

updatedAt

string · date-time

Update an OAuth application's configuration.

PUT

https://api.stackinternal.com

/v1/oauth-applications/{applicationId}

A full replacement, not a patch: name, description, redirect URIs, and scopes are all overwritten with the request values. Scopes are validated as they are on create.

Update an OAuth application's configuration. › path Parameters

applicationId

string · required

The application's identifier, as returned by the list endpoint.

Update an OAuth application's configuration. › Request Body

The full definition of an OAuth application: sent on both create and replace.

OAuthApplicationRequest

name

string | null

description

string | null

redirectUris

array | null

scopes

array | null

Update an OAuth application's configuration. › Responses

200

A registered OAuth application, including its generated client ID.

OAuthApplicationResponse

id

string | null

clientId

string | null

name

string | null

description

string | null

redirectUris

array | null

scopes

array | null

createdAt

string · date-time

updatedAt

string · date-time

PUT/v1/oauth-applications/{applicationId}

curl https://api.stackinternal.com/v1/oauth-applications/:applicationId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "description": "description",
  "redirectUris": [
    "string"
  ],
  "scopes": [
    "string"
  ]
}'

Example Request Body

{
  "name": "name",
  "description": "description",
  "redirectUris": [
    "string"
  ],
  "scopes": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "clientId": "clientId",
  "name": "name",
  "description": "description",
  "redirectUris": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

text

Delete an OAuth application.

DELETE

https://api.stackinternal.com

/v1/oauth-applications/{applicationId}

Responds 204 No Content on success.

Delete an OAuth application. › path Parameters

applicationId

string · required

The application's identifier, as returned by the list endpoint.

Delete an OAuth application. › Responses

200

No data returned

Knowledge Users