CHchargerobotics
SunriseStudioService

POST /api/v1/admin/users

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
  • Auth
    API key in header Authorization

Query parameters

user.idstring
user.usernamestring

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

user.firstNamestring
user.lastNamestring
user.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.

user.role'ROLE_UNSPECIFIED' | 'ROLE_SUPER_ADMIN' | 'ROLE_SUPER_USER' | 'ROLE_ORG_ADMIN' | 'ROLE_ORG_USER' | 'ROLE_FACTORY' | 'ROLE_DELIVERY_VEHICLE'

For users that belong to an organization, the role is set on the UserOrganization object.

  • 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.
user.sessionIdstring

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

user.isDisabledboolean
user.emailstring
user.apiKeystring

Response

A successful response.

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'ROLE_UNSPECIFIED' | 'ROLE_SUPER_ADMIN' | 'ROLE_SUPER_USER' | 'ROLE_ORG_ADMIN' | 'ROLE_ORG_USER' | 'ROLE_FACTORY' | 'ROLE_DELIVERY_VEHICLE'
  • 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

Changes

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