Get Role¶

Get a role

URI Template

GET /api/roles/{name}

{name}: Role name

Response Type

interface RoleInfo {

  // Role name
  name: string;

  // Role description
  description: string;

  // System privileges
  systemPrivileges: string[];

  // Object privileges
  objectPrivileges: ObjectPrivilegeInfo[];

  // Whether this role is assigned by default
  default: boolean;
}

Related Types

interface ObjectPrivilegeInfo {

  // Privilege type
  type: string;
  object: string[];

  // Objects of this type
  objects: string[];
}