Update Role

1 min

PUT

https://api.upstartcommerce.com/v1/user/auth/role/{roleId}

This endpoint provides the ability to update a role. All the users and active api keys that use the updated role will be automatically updated, e.g. re-logging in is not required.

System roles cannot be updated.

Required permissions:

user.role.update

Authorized system roles:

system.admin
user.mgmt

acceptstringGenerated from available response content types

x-upstart-tenantstringTenant identifier associated with the site this call is for.

x-upstart-sitestringUnique identifier for the site.

bodyobjectThis contains the data to update the role.

200This is the response indicating the role was correctly updated and returns the updated values.

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

403<p>An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.</p>

404The requested resource was not found in the NoChannel system.

409The request conflicts with the current state of the resource.

500Internal server error. The server encountered an unexpected condition that prevented it from fulfilling the request.

curl --request PUT \
     --url https://api.upstartcommerce.com/v1/user/auth/role/{roleId} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "name": ""
     }'