Skip to main content

RoleListDTO

Page of Roles

pageint32

Page of entities

perPageint32

Number of entities requested for the current page

orderstringnullable

Ordering criteria used for the current page

statusCodeint32

HTTP Status Code of the response

recordsTotalint32

Total number of Roles

roles object[]nullable

Page of Roles

  • Array [
  • externalIduuid
    namestringrequired

    Name of the Entity

    Possible values: non-empty and <= 128 characters

    descriptionstringnullable

    Description of the Entity

    isActivebooleanrequired

    True/False value that determines if this entity is Active or Disabled

    tags object[]nullable
  • Array [
  • keystringrequired

    Tag Key

    Possible values: non-empty

    valuestringrequired

    Tag Key Value

    Possible values: non-empty

  • ]
  • createdAtdate-time
    modifiedAtdate-timenullable
    createdBystringnullable
    modifiedBystringnullable
    usersCountint32

    Number of Users associated with this Role

    credentialProvidersCountint32

    Number of Credential Providers associated with this Role

    isSystemboolean

    True if this is a system included Role (e.g. SuperAdmin or Auditor)

    permissions object[]nullable

    Permissions assigned to this Role

  • Array [
  • namestringnullable

    Name of the Permission Target

    readboolean

    True if this permission allows access to Read the Permission Target, False otherwise

    writeboolean

    True if this permission allows access to Write the Permission Target, False otherwise

    isWritableboolean

    True if this permission allows access to Write the Permission Target, False otherwise

    isReadableboolean

    True if this permission allows access to Read the Permission Target, False otherwise

    accessLevelstringnullable

    Description of the Permission level

  • ]
  • resourceSets object[]nullable

    Resource Sets assigned to this Role

  • Array [
  • externalIduuid
    namestringrequired

    Name of the Entity

    Possible values: non-empty and <= 128 characters

    descriptionstringnullable

    Description of the Entity

    isActivebooleanrequired

    True/False value that determines if this entity is Active or Disabled

    tags object[]nullable
  • Array [
  • keystringrequired

    Tag Key

    Possible values: non-empty

    valuestringrequired

    Tag Key Value

    Possible values: non-empty

  • ]
  • createdAtdate-time
    modifiedAtdate-timenullable
    createdBystringnullable
    modifiedBystringnullable
    serverWorkloadCountint32nullable

    Server Workloads associated with this Resource Set

    clientWorkloadCountint32nullable

    Client Workloads associated with this Resource Set

    accessPolicyCountint32nullable

    Access Policies associated with this Resource Set

    trustProviderCountint32nullable

    Trust Providers associated with this Resource Set

    accessConditionCountint32nullable

    Access Conditions associated with this Resource Set

    credentialProviderCountint32nullable

    Credential Providers associated with this Resource Set

    rolesuuid[]nullable

    Roles associated with this Resource Set

    rolesDetailsundefined[]nullable

    Details of the Roles associated with this Resource Set

    usersstring[]nullable

    Users associated with this Resource Set

    standaloneCertificateAuthorityuuidnullable

    Standalone Certificate Authority associated with this Resource Set

  • ]
  • ]
  • RoleListDTO
    {
    "page": 0,
    "perPage": 0,
    "order": "string",
    "statusCode": 0,
    "recordsTotal": 0,
    "roles": [
    {
    "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "isActive": true,
    "tags": [
    {
    "key": "string",
    "value": "string"
    }
    ],
    "createdAt": "2024-07-29T15:51:28.071Z",
    "modifiedAt": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "usersCount": 0,
    "credentialProvidersCount": 0,
    "isSystem": true,
    "permissions": [
    {
    "name": "string",
    "read": true,
    "write": true,
    "isWritable": true,
    "isReadable": true,
    "accessLevel": "string"
    }
    ],
    "resourceSets": [
    {
    "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "isActive": true,
    "tags": [
    {
    "key": "string",
    "value": "string"
    }
    ],
    "createdAt": "2024-07-29T15:51:28.071Z",
    "modifiedAt": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "serverWorkloadCount": 0,
    "clientWorkloadCount": 0,
    "accessPolicyCount": 0,
    "trustProviderCount": 0,
    "accessConditionCount": 0,
    "credentialProviderCount": 0,
    "roles": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "rolesDetails": [
    null
    ],
    "users": [
    "string"
    ],
    "standaloneCertificateAuthority": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    ]
    }
    ]
    }