[]
(Showing Draft Content)

Client

Client

[GET] /api/v1/clients

Get all clients' information.

Parameters

Name Type Located In Description Example
PageSize int32 query The page size. 20
PageNumber int32 query The page number. 1
SearchText string query The search text. "admin"
OrderBy string query The ordered field. "UserName"
OrderType OrderType query The order type, available values are "ASC" and "DESC". "ASC"
Paging Boolean query Whether pagination or not. true
SearchType SearchType query The search type, available values are "None" and "Count". "None"

Response

Status Code: 200

Success

[POST] /api/v1/clients

Add a new client.

Request Schema

ClientBizModel

Response

Status Code: 200

Success

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

Get client by id.

Parameters

Name Type Located In Description
idRequired string path Client id.

Response

Status Code: 200

Success

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

Update an exist client.

Parameters

Name Type Located In Description
idRequired string path Client id.

Request Schema

ClientBizModel

Response

Status Code: 200

Success

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

Delete an exist client.

Parameters

Name Type Located In Description
idRequired string path Client id.

Response

Status Code: 200

Success

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

Enable/Disable specified client.

Parameters

Name Type Located In Description
idRequired string path Client id.

Request Schema

boolean

Response

Status Code: 200

Success

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

Update secret of specified client.

Parameters

Name Type Located In Description
idRequired string path Client id.

Response

Status Code: 200

Success

Models

Ƭ OrderType

Enum:

  • ASC
  • DESC

The order type.

Ƭ SearchType

Enum:

  • None
  • Count

The search type for searching records.

Ƭ ClientBizModel

Name Type Description Example
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