Type alias RoleSchema

RoleSchema: {
    created_by?: string;
    created_date: string;
    custom_attributes?: {
        [key: string]: string;
    };
    description: string;
    group_ids?: string[];
    id: string;
    is_delete_protected: boolean;
    is_group_admin?: boolean;
    is_org_admin: boolean;
    is_project_admin?: boolean;
    last_updated_by?: string;
    last_updated_date?: string;
    name: string;
    org_permissions?: OrgAccessPermissions;
    project_id?: string;
    project_ids?: string[];
    project_permissions?: ProjectAccessPermissions;
    restricted_custom_attributes: {
        [key: string]: string;
    };
    tags: string[];
}

Type declaration

  • Optional created_by?: string

    ID of the user who created this account

  • created_date: string

    UTC datetime the account was created

  • Optional custom_attributes?: {
        [key: string]: string;
    }

    Custom attributes for this user

    • [key: string]: string
  • description: string

    Description of the role

  • Optional group_ids?: string[]

    Groups they belong to, individual roles only

  • id: string

    ID of the role

  • is_delete_protected: boolean

    This must be set false before the role can be deleted

  • Optional is_group_admin?: boolean

    Whether this user is a group admin, only visible when filtered by group

  • is_org_admin: boolean

    Whether this user is an org admin

  • Optional is_project_admin?: boolean

    Whether this user is a project admin, only visible in project scope

  • Optional last_updated_by?: string

    ID of the user who last updated this account

  • Optional last_updated_date?: string

    UTC datetime the account was last updated

  • name: string

    Name of the role

  • Optional org_permissions?: OrgAccessPermissions

    Organization permissions, only included for individual users

  • Optional project_id?: string

    ID of the project this group belongs to, if any

  • Optional project_ids?: string[]

    Projects they belong to, individual roles only

  • Optional project_permissions?: ProjectAccessPermissions

    Project permissions, only included for individual users in project scope

  • restricted_custom_attributes: {
        [key: string]: string;
    }

    Custom attributes only admins can update

    • [key: string]: string
  • tags: string[]

    Tags for this role

Settings

Member Visibility

Theme