Type alias PatchRoleBody

PatchRoleBody: {
    custom_attributes?: {
        [key: string]: string;
    };
    description?: string;
    is_active?: boolean;
    is_delete_protected?: boolean;
    name?: string;
    org_permissions?: OrgAccessPermissions;
    project_permissions?: ProjectAccessPermissions;
    restricted_custom_attributes?: {
        [key: string]: string;
    };
    tags?: string[];
}

Type declaration

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

    Custom attributes for this user

    • [key: string]: string
  • Optional description?: string

    Description of the role

  • Optional is_active?: boolean

    If false, all role operations are disabled

  • Optional is_delete_protected?: boolean

    This must be set false before the role can be deleted

  • Optional name?: string

    Name of the role

  • Optional org_permissions?: OrgAccessPermissions

    Permissions for this role on the organization

  • Optional project_permissions?: ProjectAccessPermissions

    Permissions for this role on the project

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

    Custom attributes only admins can update

    • [key: string]: string
  • Optional tags?: string[]

    List of tags on this role