v1

latestOpenAPI 3.1.02026-07-241280174.1 KB

Update

patch/v3/workplace/roles/role/{role}

Path parameters

rolestring required

The role's unique identifier, which is the initial name the role was given

Request body

namestring

The name of the role

permissionsstring[]

An array containing the permissions the role has. Valid permissions are: all_enclave_projects, all_enclave_projects_admin, analytics_dashboard, billing, billing_manage, change_request_policy_manage, change_request_policy_read, create_enclave_project, custom_roles_manage, ekm, enclave_inheritance, enclave_secrets_referencing, logs, logs_audit, service_account_api_tokens, service_account_api_tokens_manage, service_account_identities, service_account_identities_manage, service_accounts, service_accounts_manage, settings, settings_manage, team, team_manage, verified_domains, verified_domains_manage, workplace_default_environments_manage, workplace_default_environments_read, workplace_integrations_create, workplace_integrations_list, workplace_integrations_manage, workplace_integrations_read

Response

200

Example response

{
  "role": {
    "name": "custom",
    "permissions": [
      "team"
    ],
    "identifier": "custom",
    "created_at": "2023-08-01T00:00:00.000Z",
    "is_custom_role": true
  }
}