/user
Internal Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| POST /user | To be used by Admin to create new User. | Available | |
| PATCH /user/{id} | To be used by Admin to update existing User. | Available | |
| DELETE /user/{id} | Delete a user for the given id. | Available | |
| PATCH /user/{id}/preferences | Update existing user preferences and return updated preferences. | Available |
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /user/lockout | Get the local user account lockout settings which are used to configure whether user accounts will be locked on failed logins, when they will be locked and the duration for which they will stay locked. | Available | |
| PATCH /user/lockout | Update the local user account lockout settings which are used to configure whether user accounts will be locked on failed logins, when they will be locked and the duration for which they will stay locked. | Available | |
| PUT /user/{id}/totp/config | Use this endpoint to configure the time-based one time password (TOTP) secret for a specified user account. The endpoint replaces an existing secret with the new one. The Rubrik cluster checks the secret against a one time password (OTP) to ensure validity. | Available | |
| DELETE /user/{id}/totp/config | Reset the TOTP settings to the default disabled state for the specified user account. | Available | |
| POST /user/{id}/totp/new_secret | Use this endpoint to generate the time-based one time password (TOTP) secret key for a specified user account. The secret is a key value encoded in Base32 and includes a URI for generating a scannable QR code. | Available | |
| GET /user/{id}/totp/status | Get the time-based one time password (TOTP) status for a specified user account. The TOTP status specifies whether TOTP is enabled and enforced for that account, and includes the TOTP settings for the user. | Available | |
| POST /user/{id}/unlock | Unlock a user account that has been locked because of too many failed login attempts. | Available | |
| POST /user/{id}/update_password | Update existing user password. | Available |