Client

[GET] /api/v1/clients

Parameters

Name	In	Type	Description
PageSize	query	integer	The page size.
PageNumber	query	integer	The page number.
SearchText	query	string	The search text.
OrderBy	query	string	The ordered field.
OrderType	query		The order type, available values are "ASC" and "DESC".
Paging	query	boolean	Whether pagination or not.
SearchType	query		The search type, available values are "None" and "Count".

Get all clients' information.

Responses

[200] Success

[POST] /api/v1/clients

Add a new client.

Request Body

Description: Client model.

Type: application/json-patch+json, application/json, text/json, application/*+json

ClientBizModel

Responses

[200] Success

[GET] /api/v1/clients/{id}

Parameters

Name	In	Type	Description
idRequired	path	string	Client id.

Get client by id.

Responses

[200] Success

[PUT] /api/v1/clients/{id}

Parameters

Name	In	Type	Description
idRequired	path	string	Client id.

Update an exist client.

Request Body

Description: Client model.

Type: application/json-patch+json, application/json, text/json, application/*+json

ClientBizModel

Responses

[200] Success

[DELETE] /api/v1/clients/{id}

Parameters

Name	In	Type	Description
idRequired	path	string	Client id.

Delete an exist client.

Responses

[200] Success

[PUT] /api/v1/clients/{id}/enable

Parameters

Name	In	Type	Description
idRequired	path	string	Client id.

Enable/Disable specified client.

Request Body

Description: true - Enable; false - Disable

Type: application/json-patch+json, application/json, text/json, application/*+json

boolean

Responses

[200] Success

[PUT] /api/v1/clients/{id}/secret

Parameters

Name	In	Type	Description
idRequired	path	string	Client id.

Update secret of specified client.

Responses

[200] Success

Models

Ƭ OrderType

Enum:

• ASC

• DESC

  The order type.

Ƭ SearchType

Enum:

• None

• Count

  The search type for searching records.

Ƭ ClientBizModel

Name	Type
clientIdNullable	string
clientNameNullable	string
clientSecretNullable	string
creatorIdNullable	string
descriptionNullable	string
enabled	Boolean
creationTime	ISO DateTime Sting
allowOfflineAccess	Boolean
allowAccessTokenViaBrowser	Boolean
requireConsent	Boolean
authCodeLifetime	int32
accessTokenType	AccessTokenType
accessTokenLifetime	int32
refreshTokenUsage	TokenUsage
refreshTokenExpirationType	TokenExpiration
slidingRefreshTokenLifetime	int32
absoluteRefreshTokenLifetime	int32
logoutSessionRequired	Boolean
alwaysIncludeUserClaimsInIdToken	Boolean
identityTokenLifetime	int32
updateAccessTokenClaimsOnRefresh	Boolean
enableLocalLogin	Boolean
includeJwtId	Boolean
alwaysSendClientClaims	Boolean
logoutUriNullable	string
protocolTypeNullable	string
requireClientSecret	Boolean
clientUriNullable	string
prefixClientClaims	Boolean
logoUriNullable	string
allowRememberConsent	Boolean
requirePkce	Boolean
allowPlainTextPkce	Boolean
allowedGrantTypesNullable	Array<string>
allowedScopesNullable	Array<string>
allowedCorsOriginsNullable	Array<string>
redirectUrisNullable	Array<string>
postLogoutRedirectUrisNullable	Array<string>
claimsNullable	string
identityProviderRestrictionsNullable	Array<string>

Ƭ AccessTokenType

Enum:

• Jwt
• Reference

Ƭ TokenUsage

Enum:

• ReUse
• OneTimeOnly

Ƭ TokenExpiration

Enum:

• Sliding
• Absolute