Users
All operations require authentication.
List usersBeta
Returns the users of the service with their roles and status. Passwords are not returned.
Path parameters
Project ID
Service ID
Headers
Pagination cursor
Pagination size
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Hash of the resource used for concurrency control
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Password of the user. Returned only on creation or password reset.
List of roles assigned to the user. Available roles depend on the engine.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/[ { "admin": true, "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "password": "string", "roles": [ "string" ], "status": "CREATING", "username": "string" }]
Get a userBeta
Returns the user, its roles and its status. The password is not returned.
Path parameters
Project ID
Service ID
User ID
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Hash of the resource used for concurrency control
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Password of the user. Returned only on creation or password reset.
List of roles assigned to the user. Available roles depend on the engine.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "admin": true, "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "password": "string", "roles": [ "string" ], "status": "CREATING", "username": "string"}
Create a userBeta
Creates a user with the given roles and generates its password. The password is returned only on creation and on password reset.
Path parameters
Project ID
Service ID
Request body (required)
Login name of the new user
List of roles to assign to the user. Available roles depend on the engine.
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Hash of the resource used for concurrency control
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Password of the user. Returned only on creation or password reset.
List of roles assigned to the user. Available roles depend on the engine.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "admin": true, "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "password": "string", "roles": [ "string" ], "status": "CREATING", "username": "string"}
Delete a userBeta
Permanently deletes the user.
Path parameters
Project ID
Service ID
User ID
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Hash of the resource used for concurrency control
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Password of the user. Returned only on creation or password reset.
List of roles assigned to the user. Available roles depend on the engine.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "admin": true, "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "password": "string", "roles": [ "string" ], "status": "CREATING", "username": "string"}
Update a userBeta
Updates the roles of the user. The roles list replaces the current roles. To reset the password, use the resetPassword route of the user or a partial update with credentialsLastUpdatedAt.
Path parameters
Project ID
Service ID
User ID
Request body (required)
List of roles to assign to the user. Available roles depend on the engine.
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Hash of the resource used for concurrency control
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Password of the user. Returned only on creation or password reset.
List of roles assigned to the user. Available roles depend on the engine.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "admin": true, "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "password": "string", "roles": [ "string" ], "status": "CREATING", "username": "string"}
Partially update a userBeta
Partially updates the roles of the user. The roles list replaces the current roles. Setting credentialsLastUpdatedAt resets the password and returns the new one.
Path parameters
Project ID
Service ID
User ID
Request body (required)
Date at which the user credentials were last updated. Setting this field triggers a credential reset and returns the new password.
List of roles to assign to the user. Available roles depend on the engine.
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Hash of the resource used for concurrency control
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Password of the user. Returned only on creation or password reset.
List of roles assigned to the user. Available roles depend on the engine.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "admin": true, "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "password": "string", "roles": [ "string" ], "status": "CREATING", "username": "string"}
List rolesBeta
Returns the roles that can be assigned to users.
Path parameters
Project ID
Service ID
Headers
Pagination cursor
Pagination size
Response
Hash of the resource used for concurrency control
Date at which the resource was created
Unique identifier of the role
Name of the role
Date of the last update to the resource
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "name": "string", "updatedAt": "2024-01-01T12:00:00Z" }]
Reset the password of a userBeta
Generates a new password for the user and returns it in the response. Reading the user never returns it. The previous password stops working once the new one is applied, and credentialsLastUpdatedAt becomes the date of this reset. This is the same reset as a partial update of the user that sets credentialsLastUpdatedAt.
Path parameters
Project ID
Service ID
User ID
Response
Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
Hash of the resource used for concurrency control
Date at which the user was created
Date at which the user credentials were last updated
Unique identifier of the user
Password of the user. Returned only on creation or password reset.
List of roles assigned to the user. Available roles depend on the engine.
Current readiness status of the user
CREATINGDELETINGERRORREADYUPDATINGLogin name of the user
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "admin": true, "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "credentialsLastUpdatedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "password": "string", "roles": [ "string" ], "status": "CREATING", "username": "string"}
Get a roleBeta
Returns a role that can be assigned to users.
Path parameters
Project ID
Role ID
Service ID
Response
Hash of the resource used for concurrency control
Date at which the resource was created
Unique identifier of the role
Name of the role
Date of the last update to the resource
Example uses projectId = string, roleId = 00000000-0000-0000-0000-000000000000, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "name": "string", "updatedAt": "2024-01-01T12:00:00Z"}