Create a user attribute

POST 
/api/web/v1/userattributes

Create a user attribute. Caller requires the USERATTRIBUTES:ADD permission.

Request

application/json

Body

required

mandatory boolean

A flag indicating if users must have a value for this user attribute. If not specified when creating a user attribute if defaults to false.

name string

The name of this user attribute. This must be specified when creating a user attribute.

type string

Possible values: [NONE, OTP_EMAIL, OTP_SMS, OTP_VOICE]

Type of user attribute.

unique boolean

A flag indicating if this attribute is intended to be unique. If not specified when creating a user attribute it defaults to false.

Responses

200

Successful

application/json

Schema

Schema

id string

The UUID for this user attribute. Generated when the user attribute is created.

mandatory booleanrequired

A flag indicating if users must have a value for this user attribute.

name stringrequired

The name of this user attribute.

systemDefined booleanrequired

A flag indicating if this user attribute is one of the system defined user attributes.

type string

Possible values: [NONE, OTP_EMAIL, OTP_SMS, OTP_VOICE]

Type of user attribute. Currently only used to specify the type of contact if the attribute is to be used for OTP delivery.

unique booleanrequired

A flag indicating if this attribute is intended to be unique.

Example (from schema)

{
  "id": "string",
  "mandatory": true,
  "name": "string",
  "systemDefined": true,
  "type": "OTP_EMAIL",
  "unique": true
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...