[]
        
(Showing Draft Content)

ApiResource

ApiResource

[GET] /api/v1/apiresources

Get all api resources.

Response

Status Code: 200

Success

[POST] /api/v1/apiresources

Add a new api resource.

Request Schema

ApiResourceBizModel

Response

Status Code: 200

Success

[GET] /api/v1/apiresources/{name}

Get api resource by name.

Parameters

Name Type Located In Description
nameRequired string path

Response

Status Code: 200

Success

[PUT] /api/v1/apiresources/{name}

Update specified api resource.

Parameters

Name Type Located In Description
nameRequired string path

Request Schema

ApiResourceBizModel

Response

Status Code: 200

Success

[DELETE] /api/v1/apiresources/{name}

Delete specified api resource by name.

Parameters

Name Type Located In Description
nameRequired string path

Response

Status Code: 200

Success

[GET] /api/v1/apiresources/{name}/scopes

Get specified api resource's scopes.

Parameters

Name Type Located In Description
nameRequired string path

Response

Status Code: 200

Success

[PUT] /api/v1/apiresources/{name}/scopes

Update specified api resource's scopes.

Parameters

Name Type Located In Description
nameRequired string path

Request Schema

Array<string>

Response

Status Code: 200

Success

[POST] /api/v1/apiresources/{name}/enable

Enable or disable specified api resource.

Parameters

Name Type Located In Description
nameRequired string path

Request Schema

boolean

Response

Status Code: 200

Success

Models

Ƭ ApiResourceBizModel

Name Type Description Example
nameNullable string
displayNameNullable string
descriptionNullable string
enabled Boolean
required Boolean
scopesNullable Array<string>
apiSecretsNullable Array<string>
userClaimsNullable Array<string>