Chapter 55. Rbac Service
55.1. Rbac Service
55.1.1. GetRole
GET /v1/rbac/roles/{id}
55.1.1.1. Description
55.1.1.2. Parameters
55.1.1.2.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id | X | null |
55.1.1.3. Return Type
55.1.1.4. Content Type
- application/json
55.1.1.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
55.1.1.6. Samples
55.1.2. GetRoleBinding
GET /v1/rbac/bindings/{id}
55.1.2.1. Description
55.1.2.2. Parameters
55.1.2.2.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id | X | null |
55.1.2.3. Return Type
55.1.2.4. Content Type
- application/json
55.1.2.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
55.1.2.6. Samples
55.1.3. GetSubject
GET /v1/rbac/subject/{id}
Subjects served from this API are Groups and Users only. Id in this case is the Name field, since for users and groups, that is unique, and subjects do not have IDs.
55.1.3.1. Description
55.1.3.2. Parameters
55.1.3.2.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id | X | null |
55.1.3.3. Return Type
55.1.3.4. Content Type
- application/json
55.1.3.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
55.1.3.6. Samples
55.1.4. ListRoleBindings
GET /v1/rbac/bindings
55.1.4.1. Description
55.1.4.2. Parameters
55.1.4.2.1. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
query | - | null | ||
pagination.limit | - | null | ||
pagination.offset | - | null | ||
pagination.sortOption.field | - | null | ||
pagination.sortOption.reversed | - | null | ||
pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
pagination.sortOption.aggregateBy.distinct | - | null |
55.1.4.3. Return Type
55.1.4.4. Content Type
- application/json
55.1.4.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
55.1.4.6. Samples
55.1.5. ListRoles
GET /v1/rbac/roles
55.1.5.1. Description
55.1.5.2. Parameters
55.1.5.2.1. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
query | - | null | ||
pagination.limit | - | null | ||
pagination.offset | - | null | ||
pagination.sortOption.field | - | null | ||
pagination.sortOption.reversed | - | null | ||
pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
pagination.sortOption.aggregateBy.distinct | - | null |
55.1.5.3. Return Type
55.1.5.4. Content Type
- application/json
55.1.5.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
55.1.5.6. Samples
55.1.6. ListSubjects
GET /v1/rbac/subjects
55.1.6.1. Description
55.1.6.2. Parameters
55.1.6.2.1. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
query | - | null | ||
pagination.limit | - | null | ||
pagination.offset | - | null | ||
pagination.sortOption.field | - | null | ||
pagination.sortOption.reversed | - | null | ||
pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
pagination.sortOption.aggregateBy.distinct | - | null |
55.1.6.3. Return Type
55.1.6.4. Content Type
- application/json
55.1.6.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |