Skip to main content

Create or overwrite a password credential.​

Creates or overwrites the password credential linked to the specified person in your organization. This credential will then be available for use in future authentication challenges.

Path Parameters
  • person_id string required

    The person ID

    Example: 903c1ff9-f2cc-435c-b242-9d8a690fcf0a
Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Request Body required

The password credential creation/overwrite request

  • type string required

    Possible values: [public-key, password, totp]

    The type of the credential

  • params object required
  • password_hash string required

    A hash of a password, in the one of the formats accepts by SlashID. SlashID supports the following hashing functions:

    • pbkdf2
    • bcrypt
    • argon2i
    • argon2id Hashes created using a function not listed here will be rejected. In all of these cases, SlashID accepts hashes in the format described here. The only departure from the specification described is that the hashing function version can include the characters [a-z0-9], to accommodate bcrypt versions (2, 2a, 2b, 2x, 2y). SlashID also accepts password hashes in the format used by bcrypt. If a password hash matches this format, it is assumed that the hashing function used was bcrypt. If any other hashing function was used to hash the password, the hash must be in the SlashID hash format.
  • label string
Responses

OK

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • errors object[]
  • httpcode integer
  • message string
PUT /persons/:person_id/credentials/password
https://api.slashid.com

Authorization

type: apiKeyname: SlashID-API-Keyin: header

Request

ApiKeyAuth
person_id — path required
SlashID-OrgID — header required
Body required
{

  "type": "public-key",

  "params": {

    "password_hash": "string"

  },

  "label": "string"

}

curl -L -X PUT 'https://api.slashid.com/persons/:person_id/credentials/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'SlashID-OrgID: <SLASHID_ORG_ID_VALUE>' \
-H 'SlashID-API-Key: <API_KEY_VALUE>' \
--data-raw '{
  "type": "public-key",
  "params": {
    "password_hash": "string"
  },
  "label": "string"
}'