Client Credential Clients Roles
- Last UpdatedJan 20, 2023
- 4 minute read
APIs for getting, updating, and deleting client credential client roles.
List Roles for Client Credential Client (Client Credential Clients path)
Returns a list of roles for the specified client credential client.
Request
GET /api/v1/Tenants/{tenantId}/ClientCredentialClients/{clientId}/Roles
?query={query}&skip={skip}&count={count}
Parameters
string tenantId
Tenant identifier.string clientId
Client identifier.
[optional] string query
(Not supported) Search string identifier.[optional] integer skip
Parameter representing the zero-based offset of the first object to retrieve. If unspecified, a default value of 0 is used.[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | Role[] | List of client credential client roles |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 403 | ErrorResponse | Forbidden. |
| 404 | ErrorResponse | Client or tenant not found |
| 408 | ErrorResponse | None |
| 500 | ErrorResponse | Internal server error. |
Example response body
200 Response (Role[])
[
{
"Id": "string",
"Name": "string",
"Description": "string",
"RoleScope": 0,
"TenantId": "string",
"CommunityId": "string",
"RoleTypeId": "string"
}
]
Authorization
Allowed for these roles:
- Self
- Tenant Member
Get Roles for Client Credential Client Header (Client Credential Clients path)
Returns the roles for the client credential client header.
Request
HEAD /api/v1/Tenants/{tenantId}/ClientCredentialClients/{clientId}/Roles
Parameters
string tenantId
Tenant identifier.string clientId
Client identifier.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | None | Header for specified client credential client roles |
| 401 | None | Unauthorized. |
| 403 | None | Forbidden. |
| 404 | None | Client or tenant not found |
| 500 | None | Internal server error. |
Authorization
Allowed for these roles:
- Self
- Tenant Member
Replace Client Credential Client's Roles (Client Credential Clients path)
Replaces existing client credential client roles.
Request
PUT /api/v1/Tenants/{tenantId}/ClientCredentialClients/{clientId}/Roles
Parameters
string tenantId
Tenant identifier.string clientId
Client identifier.
Request Body
Updates roles list
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | Role[] | List of updated client credential client roles |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 403 | ErrorResponse | Forbidden. |
| 404 | ErrorResponse | Client or tenant not found |
| 408 | ErrorResponse | Operation timed out. |
| 500 | ErrorResponse | Internal server error. |
Example response body
200 Response (Role[])
[
{
"Id": "string",
"Name": "string",
"Description": "string",
"RoleScope": 0,
"TenantId": "string",
"CommunityId": "string",
"RoleTypeId": "string"
}
]
Authorization
Allowed for these roles:
- Tenant Administrator
List Roles for Client Credential Client (Clients path)
Returns a list of roles for the specified client credential client.
Request
GET /api/v1/Tenants/{tenantId}/Clients/{clientId}/Roles
?query={query}&skip={skip}&count={count}
Parameters
string tenantId
Tenant identifier.string clientId
Client identifier.
[optional] string query
(Not supported) Search string identifier.[optional] integer skip
Parameter representing the zero-based offset of the first object to retrieve. If unspecified, a default value of 0 is used.[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | Role[] | List of client credential client roles |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 403 | ErrorResponse | Forbidden. |
| 404 | ErrorResponse | Client or tenant not found |
| 408 | ErrorResponse | None |
| 500 | ErrorResponse | Internal server error. |
Example response body
200 Response (Role[])
[
{
"Id": "string",
"Name": "string",
"Description": "string",
"RoleScope": 0,
"TenantId": "string",
"CommunityId": "string",
"RoleTypeId": "string"
}
]
Authorization
Allowed for these roles:
- Self
- Tenant Member
Get Roles for Client Credential Client Header (Clients path)
Returns the roles for the client credential client header.
Request
HEAD /api/v1/Tenants/{tenantId}/Clients/{clientId}/Roles
Parameters
string tenantId
Tenant identifier.string clientId
Client identifier.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | None | Header for specified client credential client roles |
| 401 | None | Unauthorized. |
| 403 | None | Forbidden. |
| 404 | None | Client or tenant not found |
| 500 | None | Internal server error. |
Authorization
Allowed for these roles:
- Self
- Tenant Member
Replace Client Credential Client's Roles (Clients path)
Replaces existing client credential client roles.
Request
PUT /api/v1/Tenants/{tenantId}/Clients/{clientId}/Roles
Parameters
string tenantId
Tenant identifier.string clientId
Client identifier.
Request Body
Updates roles list
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | Role[] | List of updated client credential client roles |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 401 | ErrorResponse | Unauthorized. |
| 403 | ErrorResponse | Forbidden. |
| 404 | ErrorResponse | Client or tenant not found |
| 408 | ErrorResponse | Operation timed out. |
| 500 | ErrorResponse | Internal server error. |
Example response body
200 Response (Role[])
[
{
"Id": "string",
"Name": "string",
"Description": "string",
"RoleScope": 0,
"TenantId": "string",
"CommunityId": "string",
"RoleTypeId": "string"
}
]
Authorization
Allowed for these roles:
- Tenant Administrator
Definitions
Role
Object for retrieving a role
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Id | string | false | true | Role identifier. Generated by the server upon creation. |
| Name | string | false | true | Role name. This cannot be empty. |
| Description | string | false | true | Role description |
| RoleScope | RoleScope | false | true | Role scope |
| TenantId | string | false | true | Tenant identifier, if this is a Tenant Role. Otherwise, set to null. |
| CommunityId | string | false | true | Community identifier, if this is a Community Role. Otherwise set to null. |
| RoleTypeId | string | false | true | Role type identifier for built-in roles |
{
"Id": "string",
"Name": "string",
"Description": "string",
"RoleScope": 0,
"TenantId": "string",
"CommunityId": "string",
"RoleTypeId": "string"
}
RoleScope
The object that represents the scope of a given role
Enumerated Values
| Property | Value |
|---|---|
| None | 0 |
| Tenant | 1 |
| Community | 2 |
| Cluster | 3 |
ErrorResponse
Object returned whenever there is an error
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| OperationId | string | true | false | Operation identifier of action that caused the error |
| Error | string | true | false | Error description |
| Reason | string | true | false | Reason for the error |
| Resolution | string | true | false | Resolution to resolve the error |
| DynamicProperties | object | false | true | Additional properties |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"DynamicProperties": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}