Admin Roles

Update Site Role

Update a SITE-scoped role's name, description, and/or permissions.

Permission: role.write (SITE-level)

patch/api/v1/admin/roles/{role_public_id}

Request

  • Base URL: https://api.sanifu.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.sanifu.ai/api/v1/admin/roles/{role_public_id}
  • Auth: one of:
    • OAuth 2 (password, token URL auth/jwt/login)
    • HTTP basic

Path parameters

role_public_idstring uuid required

Request body

namestring nullable
descriptionstring nullable
permission_idsinteger[] nullable

Response

Successful Response

public_idstring uuid nullable
created_atstring date-time nullable
created_by_idinteger nullable
updated_atstring date-time nullable
updated_by_idinteger nullable
is_archivedboolean nullable
archived_atstring date-time nullable
archived_by_idinteger nullable
is_activeboolean nullable
idinteger required
namestring required
descriptionstring nullable
scope'site' | 'organization' | 'agent' required
organization_idinteger nullable
agent_idinteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.