5.5 KiB
Dex API
The Dex REST API
Version: v1
Models
Client
{
id: string,
redirectURIs: [
string
]
}
ClientPage
{
clients: [
Client
],
nextPageToken: string
}
ClientWithSecret
{
id: string,
redirectURIs: [
string
],
secret: string
}
Error
{
error: string,
error_description: string
}
RefreshClient
A client with associated public metadata.
{
clientID: string,
clientName: string,
clientURI: string,
logoURI: string
}
RefreshClientList
{
clients: [
RefreshClient
]
}
ResendEmailInvitationRequest
{
redirectURL: string
}
ResendEmailInvitationResponse
{
emailSent: boolean,
resetPasswordLink: string
}
User
{
admin: boolean,
createdAt: string,
disabled: boolean,
displayName: string,
email: string,
emailVerified: boolean,
id: string
}
UserCreateRequest
{
redirectURL: string,
user: User
}
UserCreateResponse
{
emailSent: boolean,
resetPasswordLink: string,
user: User
}
UserDisableRequest
{
disable: boolean // If true, disable this user, if false, enable them. No error is signaled if the user state doesn't change.
}
UserDisableResponse
{
ok: boolean
}
UserResponse
{
user: User
}
UsersResponse
{
nextPageToken: string,
users: [
User
]
}
Paths
GET /account/{userid}/refresh
Summary
List RefreshClient
Description
List all clients that hold refresh tokens for the specified user.
Parameters
Name Located in Description Required Type userid path Yes string
Responses
Code Description Type 200 RefreshClientList default Unexpected error
DELETE /account/{userid}/refresh/{clientid}
Summary
Revoke RefreshClient
Description
Revoke all refresh tokens issues to the client for the specified user.
Parameters
Name Located in Description Required Type clientid path Yes string userid path Yes string
Responses
Code Description Type default Unexpected error
GET /clients
Summary
List Clients
Description
Retrieve a page of Client objects.
Parameters
Name Located in Description Required Type nextPageToken query No string
Responses
Code Description Type 200 ClientPage default Unexpected error
POST /clients
Summary
Create Clients
Description
Register a new Client.
Parameters
Name Located in Description Required Type body Yes Client
Responses
Code Description Type 200 ClientWithSecret default Unexpected error
GET /users
Summary
List Users
Description
Retrieve a page of User objects.
Parameters
Name Located in Description Required Type nextPageToken query No string maxResults query No integer
Responses
Code Description Type 200 UsersResponse default Unexpected error
POST /users
Summary
Create Users
Description
Create a new User.
Parameters
Name Located in Description Required Type body Yes UserCreateRequest
Responses
Code Description Type 200 UserCreateResponse default Unexpected error
GET /users/{id}
Summary
Get Users
Description
Get a single User object by id.
Parameters
Name Located in Description Required Type id path Yes string
Responses
Code Description Type 200 UserResponse default Unexpected error
POST /users/{id}/disable
Summary
Disable Users
Description
Enable or disable a user.
Parameters
Name Located in Description Required Type id path Yes string body Yes UserDisableRequest
Responses
Code Description Type 200 UserDisableResponse default Unexpected error
POST /users/{id}/resend-invitation
Summary
ResendEmailInvitation Users
Description
Resend invitation email to an existing user with unverified email.
Parameters
Name Located in Description Required Type id path Yes string body Yes ResendEmailInvitationRequest
Responses
Code Description Type 200 ResendEmailInvitationResponse default Unexpected error