Skip to main content
Browse docs

OAuth 2.0 API

11 endpoints — authenticate with a workspace access token via Authorization: Bearer. See the API introduction for base URLs, pagination, and rate limits.

List Clients

GET/api/oauth2/

List OAuth2 clients belonging to the authenticated user.

Query parameters

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Returns 200 with PaginatedList_OAuth2Client_.

curl -X GET \
  https://api.rapidly.tech/api/oauth2/ \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN"

Create Client

POST/api/oauth2/register

Register a new OAuth2 client (RFC 7591).

Request body OAuth2ClientConfiguration

client_namestringrequired

Client Name

redirect_urisstring[]required

Redirect Uris

token_endpoint_auth_method"client_secret_basic" | "client_secret_post" | "none"

Token Endpoint Auth Method

grant_types"authorization_code" | "refresh_token"[]

Grant Types

response_typesstring[]

Response Types

scopestring

Scope

client_uristring | null

Client Uri

logo_uristring | null

Logo Uri

tos_uristring | null

Tos Uri

policy_uristring | null

Policy Uri

default_sub_type"user" | "workspace"

SubType

Returns 200 with object.

curl -X POST \
  https://api.rapidly.tech/api/oauth2/register \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Get Client

GET/api/oauth2/register/{client_id}

Read an OAuth2 client's configuration (RFC 7592).

Path parameters

client_idstringrequired

Returns 200 with object.

curl -X GET \
  https://api.rapidly.tech/api/oauth2/register/{client_id} \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN"

Update Client

PUT/api/oauth2/register/{client_id}

Update an OAuth2 client's configuration (RFC 7592).

Path parameters

client_idstringrequired

Request body OAuth2ClientConfigurationUpdate

client_idstring | null

Client Id

client_namestring | null

Client Name

redirect_urisstring[] | null

Redirect Uris

token_endpoint_auth_method"client_secret_basic" | "client_secret_post" | "none" | null

Token Endpoint Auth Method

grant_types"authorization_code" | "refresh_token"[] | null

Grant Types

response_typesstring[] | null

Response Types

scopestring | null

Scope

client_uristring | null

Client Uri

logo_uristring | null

Logo Uri

tos_uristring | null

Tos Uri

policy_uristring | null

Policy Uri

default_sub_type"user" | "workspace" | null

Returns 200 with object.

curl -X PUT \
  https://api.rapidly.tech/api/oauth2/register/{client_id} \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Delete Client

DELETE/api/oauth2/register/{client_id}

Soft-delete an OAuth2 client (RFC 7592).

Path parameters

client_idstringrequired

Returns 200 with object.

curl -X DELETE \
  https://api.rapidly.tech/api/oauth2/register/{client_id} \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN"

Authorize

GET/api/oauth2/authorize

Begin the authorization code flow (returns consent metadata or auto-approves).

Returns 200 with object.

curl -X GET \
  https://api.rapidly.tech/api/oauth2/authorize \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN"

POST/api/oauth2/consent

Handle the user's consent decision (allow or deny).

Returns 200 with object.

curl -X POST \
  https://api.rapidly.tech/api/oauth2/consent \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Request Token

POST/api/oauth2/token

Exchange a grant for an access token.

Returns 200 with TokenResponse.

curl -X POST \
  https://api.rapidly.tech/api/oauth2/token \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Revoke Token

POST/api/oauth2/revoke

Revoke an access or refresh token.

Returns 200 with RevokeTokenResponse.

curl -X POST \
  https://api.rapidly.tech/api/oauth2/revoke \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Introspect Token

POST/api/oauth2/introspect

Return metadata about an active token.

Returns 200 with IntrospectTokenResponse.

curl -X POST \
  https://api.rapidly.tech/api/oauth2/introspect \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Get User Info

GET/api/oauth2/userinfo

Return OpenID Connect claims for the authenticated subject.

Returns 200 with UserInfoUser | UserInfoWorkspace.

curl -X GET \
  https://api.rapidly.tech/api/oauth2/userinfo \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN"