Create credentials

Request

Creates new password credentials for a user that doesn't already have a password. The password is temporary, and must be reset upon the user's first login.

Required permissions: apps:create, [appId]:create, authenticators:create.

Security

ClientAccessToken

Path

user_idstringrequired

The ID of the user

Bodyapplication/jsonrequired

passwordstringrequired

The user's new password

force_replaceboolean

When true the password is temporary and the user will be required to replace it upon successful login

Default:true

device_idstring

The device associated with this registration.

usernamestring

The user's new username. This will be the identifier the user will use to authenticate. If username is not provided and the user has verified their email, that email address will be used as the username.

enforce_complexityboolean

If true, the password must meet the password complexity requirements. If false, the password can be any string.

Default:true

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/password' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": "string",
    "force_replace": true,
    "device_id": "string",
    "username": "string",
    "enforce_complexity": true
  }'

Responses

Bodyapplication/json

resultobjectrequired

Response

{
  "result": {
    "message": "Password registered"
  }
}