IdentityRoleDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Contains information about an existing identity role, including its name, visibility, and assignment status. Returned in role listing and retrieval operations.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||
|---|---|---|---|---|---|---|
extraProperties
required |
object | Holds additional metadata or custom attributes for the role.
nullableread only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
id
required |
string (uuid) | The unique identifier of the role.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
isDeleted
required |
boolean | Indicates whether this entity has been deleted.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
name
required |
string | The display name of the role.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
isDefault
required |
boolean | Indicates whether this role is automatically assigned to new users by default.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
isStatic
required |
boolean | Indicates whether the role is system-defined and cannot be deleted or renamed.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
isPublic
required |
boolean | Determines whether the role is visible to users for self-assignment.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
userCount
required |
integer (int64) | The number of users currently assigned to this role.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
concurrencyStamp
required |
string | A concurrency token used to detect conflicting updates to the role.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
roleType
required |
RoleType RoleType | The classification of the role, such as default or custom.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.