All URIs are relative to https://sandbox-iam.us.hypto.com/v1
| Method | HTTP request | Description |
|---|---|---|
| changePassword | POST /organizations/{organization_id}/users/{user_name}/change_password | Change password for a user |
| createUser | POST /organizations/{organization_id}/users | Create a user |
| deleteUser | DELETE /organizations/{organization_id}/users/{user_name} | Delete a User |
| getUser | GET /organizations/{organization_id}/users/{user_name} | Gets a user entity associated with the organization |
| listUsers | GET /organizations/{organization_id}/users | List users |
| resetPassword | POST /organizations/{organization_id}/users/resetPassword | Reset Password |
| updateUser | PATCH /organizations/{organization_id}/users/{user_name} | Update a User |
BaseSuccessResponse changePassword(user_name, organization_id, ChangeUserPasswordRequest)
Change password for a user
Change password for a user
| Name | Type | Description | Notes |
|---|---|---|---|
| user_name | String | [default to null] | |
| organization_id | String | [default to null] | |
| ChangeUserPasswordRequest | ChangeUserPasswordRequest | Payload to change user password |
- Content-Type: application/json
- Accept: application/json
User createUser(organization_id, CreateUserRequest)
Create a user
User is an entity which represent a person who is part of the organization or account. This user entity can be created either through user name, password or the user can be federated through an identity provider like Google, Facebook or any SAML 2.0, OIDC identity provider. This is a sign-up api to create a new user in an organization.
| Name | Type | Description | Notes |
|---|---|---|---|
| organization_id | String | [default to null] | |
| CreateUserRequest | CreateUserRequest | Payload to create user |
- Content-Type: application/json
- Accept: application/json
BaseSuccessResponse deleteUser(user_name, organization_id)
Delete a User
Delete a User
| Name | Type | Description | Notes |
|---|---|---|---|
| user_name | String | [default to null] | |
| organization_id | String | [default to null] |
- Content-Type: Not defined
- Accept: application/json
User getUser(user_name, organization_id)
Gets a user entity associated with the organization
Get a User
| Name | Type | Description | Notes |
|---|---|---|---|
| user_name | String | [default to null] | |
| organization_id | String | [default to null] |
- Content-Type: Not defined
- Accept: application/json
UserPaginatedResponse listUsers(organization_id, nextToken, pageSize)
List users
List users associated with the organization. This is a pagniated api which returns the list of users with a next page token.
| Name | Type | Description | Notes |
|---|---|---|---|
| organization_id | String | [default to null] | |
| nextToken | String | [optional] [default to null] | |
| pageSize | String | [optional] [default to null] |
- Content-Type: Not defined
- Accept: application/json
BaseSuccessResponse resetPassword(organization_id, ResetPasswordRequest)
Reset Password
Reset Password
| Name | Type | Description | Notes |
|---|---|---|---|
| organization_id | String | [default to null] | |
| ResetPasswordRequest | ResetPasswordRequest | Payload to reset password |
- Content-Type: application/json
- Accept: application/json
User updateUser(user_name, organization_id, UpdateUserRequest)
Update a User
Update a User
| Name | Type | Description | Notes |
|---|---|---|---|
| user_name | String | [default to null] | |
| organization_id | String | [default to null] | |
| UpdateUserRequest | UpdateUserRequest | Payload to update user |
- Content-Type: application/json
- Accept: application/json