Update a workspace role.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Put, RequestUri = new Uri("https://example.com/api/workspace/roles/example"), Content = new StringContent("{ \"Name\": \"example\", \"Description\": \"example\", \"AutoAssign\": true, \"ExtendedData\": { \"additionalProperty\": \"example\" } }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/roles/example';const options = { method: 'PUT', headers: {'Content-Type': 'application/json'}, body: '{"Name":"example","Description":"example","AutoAssign":true,"ExtendedData":{"additionalProperty":"example"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/api/workspace/roles/example \ --header 'Content-Type: application/json' \ --data '{ "Name": "example", "Description": "example", "AutoAssign": true, "ExtendedData": { "additionalProperty": "example" } }'Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Request payload to update a workspace role.
object
Role display name.
Role description.
Whether to auto-assign the role to new users.
Optional complete replacement of non-secret integration metadata. Null preserves existing metadata.
object
Examplegenerated
{ "Name": "example", "Description": "example", "AutoAssign": true, "ExtendedData": { "additionalProperty": "example" }}Request payload to update a workspace role.
object
Role display name.
Role description.
Whether to auto-assign the role to new users.
Optional complete replacement of non-secret integration metadata. Null preserves existing metadata.
object
Examplegenerated
{ "Name": "example", "Description": "example", "AutoAssign": true, "ExtendedData": { "additionalProperty": "example" }}Request payload to update a workspace role.
object
Role display name.
Role description.
Whether to auto-assign the role to new users.
Optional complete replacement of non-secret integration metadata. Null preserves existing metadata.
object
Examplegenerated
{ "Name": "example", "Description": "example", "AutoAssign": true, "ExtendedData": { "additionalProperty": "example" }}Responses
Section titled “Responses”OK
object
Full details for a workspace role.
object
Role identifier.
Role display name.
Role description.
Whether the role is auto-assigned to new users.
Whether the role is a protected system role.
Tag names assigned to the role.
Users assigned to the role.
Summary projection for a workspace user.
object
User identifier.
Exact stored Unicode login name.
Optional email address.
First name.
Last name.
Whether the user is blocked from signing in.
Whether the user is soft deleted.
Avatar presentation values for a workspace user.
object
Initials derived from the user name.
Hex color for the avatar background.
Hex color for the avatar text.
Roles assigned to this user.
Summary of a workspace role.
object
Role identifier.
Role display name.
Role description.
Whether the role is auto-assigned to new users.
Whether the role is a protected system role.
Number of users assigned to this role.
Number of permissions assigned to this role.
Tag names assigned to the role.
Non-secret integration metadata.
object
Whether local password authentication is available.
Safe current external identity state attached to a local user projection.
object
Provider-owned profile metadata. It is never an authorization input.
object
Whether the optional email address has been confirmed.
Opaque concurrency token.
Non-secret integration metadata.
object
Canonical display name.
Current Work Schedule association projected into a user read model.
object
Field-safe reference to the Worker associated with a workspace user.
object
Non-secret integration metadata.
object
object
object
object
object
Example
{ "Data": { "Users": [ { "UserType": 0, "ExternalIdentity": { "ProviderKind": 1, "Status": 1, "DiagnosticCode": 0 } } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Full details for a workspace role.
object
Role identifier.
Role display name.
Role description.
Whether the role is auto-assigned to new users.
Whether the role is a protected system role.
Tag names assigned to the role.
Users assigned to the role.
Summary projection for a workspace user.
object
User identifier.
Exact stored Unicode login name.
Optional email address.
First name.
Last name.
Whether the user is blocked from signing in.
Whether the user is soft deleted.
Avatar presentation values for a workspace user.
object
Initials derived from the user name.
Hex color for the avatar background.
Hex color for the avatar text.
Roles assigned to this user.
Summary of a workspace role.
object
Role identifier.
Role display name.
Role description.
Whether the role is auto-assigned to new users.
Whether the role is a protected system role.
Number of users assigned to this role.
Number of permissions assigned to this role.
Tag names assigned to the role.
Non-secret integration metadata.
object
Whether local password authentication is available.
Safe current external identity state attached to a local user projection.
object
Provider-owned profile metadata. It is never an authorization input.
object
Whether the optional email address has been confirmed.
Opaque concurrency token.
Non-secret integration metadata.
object
Canonical display name.
Current Work Schedule association projected into a user read model.
object
Field-safe reference to the Worker associated with a workspace user.
object
Non-secret integration metadata.
object
object
object
object
object
Example
{ "Data": { "Users": [ { "UserType": 0, "ExternalIdentity": { "ProviderKind": 1, "Status": 1, "DiagnosticCode": 0 } } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Full details for a workspace role.
object
Role identifier.
Role display name.
Role description.
Whether the role is auto-assigned to new users.
Whether the role is a protected system role.
Tag names assigned to the role.
Users assigned to the role.
Summary projection for a workspace user.
object
User identifier.
Exact stored Unicode login name.
Optional email address.
First name.
Last name.
Whether the user is blocked from signing in.
Whether the user is soft deleted.
Avatar presentation values for a workspace user.
object
Initials derived from the user name.
Hex color for the avatar background.
Hex color for the avatar text.
Roles assigned to this user.
Summary of a workspace role.
object
Role identifier.
Role display name.
Role description.
Whether the role is auto-assigned to new users.
Whether the role is a protected system role.
Number of users assigned to this role.
Number of permissions assigned to this role.
Tag names assigned to the role.
Non-secret integration metadata.
object
Whether local password authentication is available.
Safe current external identity state attached to a local user projection.
object
Provider-owned profile metadata. It is never an authorization input.
object
Whether the optional email address has been confirmed.
Opaque concurrency token.
Non-secret integration metadata.
object
Canonical display name.
Current Work Schedule association projected into a user read model.
object
Field-safe reference to the Worker associated with a workspace user.
object
Non-secret integration metadata.
object
object
object
object
object
Example
{ "Data": { "Users": [ { "UserType": 0, "ExternalIdentity": { "ProviderKind": 1, "Status": 1, "DiagnosticCode": 0 } } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}