AuthClient

Manages OAuth2 client registrations. The OAuth2 client acts on behalf of the user to request resource access permissions and securely exchange credentials for access tokens to interact with protected APIs

---

Query the list of oauth2 registered client

GET

/api/v1/auth/client

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

dto*

类型object

必填

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/auth/client

试验场

服务器

授权

UserHttpBearer

变量

键

值

dto*

示例

cURL

JavaScript

PHP

Python

---

Replace oauth2 registered client

PUT

/api/v1/auth/client

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": "string",

"clientId": "string",

"clientSecret": "string",

"clientSecretExpiresAt": "string",

"clientName": "string",

"clientAuthenticationMethods": [

"string"

],

"authorizationGrantTypes": [

"string"

],

"redirectUris": [

"string"

],

"postLogoutRedirectUris": [

"string"

],

"scopes": [

"string"

],

"clientSettings": {

"additionalProperties": {

}

},

"tokenSettings": {

"additionalProperties": {

}

},

"description": "string",

"enabled": "true",

"platform": "XCAN_TP",

"source": "XCAN_USER_TOKEN",

"bizTag": "string",

"tenantId": "string",

"tenantName": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/auth/client

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Add oauth2 registered client

POST

/api/v1/auth/client

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": "string",

"clientId": "string",

"clientSecret": "string",

"clientSecretExpiresAt": "string",

"clientName": "string",

"clientAuthenticationMethods": [

"string"

],

"authorizationGrantTypes": [

"string"

],

"redirectUris": [

"string"

],

"postLogoutRedirectUris": [

"string"

],

"scopes": [

"string"

],

"clientSettings": {

"additionalProperties": {

}

},

"tokenSettings": {

"additionalProperties": {

}

},

"description": "string",

"enabled": "true",

"platform": "XCAN_TP",

"source": "XCAN_USER_TOKEN",

"bizTag": "string",

"tenantId": "string",

"tenantName": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/auth/client

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Delete oauth2 registered clients

DELETE

/api/v1/auth/client

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/auth/client

试验场

服务器

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Update oauth2 registered client

PATCH

/api/v1/auth/client

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": "string",

"clientSecret": "string",

"clientSecretExpiresAt": "string",

"clientName": "string",

"clientAuthenticationMethods": [

"string"

],

"authorizationGrantTypes": [

"string"

],

"redirectUris": [

"string"

],

"postLogoutRedirectUris": [

"string"

],

"scopes": [

"string"

],

"clientSettings": {

"additionalProperties": {

}

},

"tokenSettings": {

"additionalProperties": {

}

},

"description": "string",

"enabled": "true",

"bizTag": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/auth/client

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the detail of oauth2 registered client

GET

/api/v1/auth/client/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Client id

类型string

必填

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/auth/client/{id}

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---