SunriseStudioService

PATCH /api/v1/admin/users/{userId}

Request

Base URL
https://app.chargerobotics.com (the document declares no server; this is the origin it was published from)
URL
https://app.chargerobotics.com/api/v1/admin/users/{userId}
Auth
API key in header Authorization

Path parameters

userIdstring required

Query parameters

updateMask.pathsstring[]

Request body

idstring

usernamestring

For human users, this is their email address. For machine users such as the factory PC, this is their hostname.

firstNamestring

lastNamestring

passwordstring

When creating a user, the raw password is inputted using this field. When the user is created, the password is hashed this field is replaced with the hashed password before being stored in the database. When a user tries to login, the input password is hashed and compared with this field.

ROLE_SUPER_ADMIN: Global admin role.
ROLE_SUPER_USER: Global non-admin role.
ROLE_ORG_ADMIN: Admin role for an organization.
ROLE_ORG_USER: Non-admin role for an organization.
ROLE_FACTORY: Factory role.
ROLE_DELIVERY_VEHICLE: Delivery vehicle role.

sessionIdstring

Identifies the current session id. Changing this value will invalidate all associated refresh tokens.

isDisabledboolean

emailstring

apiKeystring

Response

A successful response.