POST
/
extended_attributes
/
{extended_attribute_id}
/
custom-attributes
Create a new custom attribute
curl --request POST \
  --url http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id}/custom-attributes \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "Name": "Terms of use",
  "Identifier": "terms-of-use",
  "Description": "I have read and agreed with...",
  "Behaviour": 3,
  "DropdownValues": "Fleet_management,Cities,EV_management",
  "ValidationRegExp": "www\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+",
  "AddToKeyMetadata": true,
  "Required": true,
  "ShowOnSignUp": true,
  "WriteOnceReadMany": true,
  "Type": 2
}'
{
  "Name": "Terms of use",
  "Identifier": "terms-of-use",
  "Description": "I have read and agreed with...",
  "Behaviour": 3,
  "DropdownValues": "Fleet_management,Cities,EV_management",
  "ValidationRegExp": "www\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+",
  "AddToKeyMetadata": true,
  "Required": true,
  "ShowOnSignUp": true,
  "WriteOnceReadMany": true,
  "ID": 1,
  "Type": 2
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
extended_attribute_id
integer
required

UID of extended attribute

Example:

1

Body

application/json
​
Name
string

Label for custom attribute

Example:

"Terms of use"

​
Identifier
string

Unique string identifier for custom attribute

Example:

"terms-of-use"

​
Description
string

Description for custom attribute

Example:

"I have read and agreed with..."

​
Behaviour
enum<integer>

custom attribute behaviour: 1 -> Developers can view and edit the attribute, 2 -> Developers can only view the attribute, 3 -> Developers cannot see the attribute

Available options:
1,
2,
3
Example:

3

​
DropdownValues
string

Values to display in dropdown options if the attribute type is 2

Example:

"Fleet_management,Cities,EV_management"

​
ValidationRegExp
string

Validation to be applied for string type attributes (type 1)

Example:

"www\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+"

​
AddToKeyMetadata
boolean

Defines if the value of this custom attribute should be injected into the credential's metadata

Example:

true

​
Required
boolean

Defines if the value of this custom attribute is required to create a new object

Example:

true

​
ShowOnSignUp
boolean

Defines if this custom attribute should be displayed in the sign up form

Example:

true

​
WriteOnceReadMany
boolean

If set to true the value is set only once for the first time

Example:

true

​
Type
enum<integer>

custom attribute type: 1 -> String, 2 -> Dropdown, 3 -> Boolean, 4 -> Number

Available options:
1,
2,
3,
4
Example:

2

Response

201 - application/json

OK

​
Name
string

Label for custom attribute

Example:

"Terms of use"

​
Identifier
string

Unique string identifier for custom attribute

Example:

"terms-of-use"

​
Description
string

Description for custom attribute

Example:

"I have read and agreed with..."

​
Behaviour
enum<integer>

custom attribute behaviour: 1 -> Developers can view and edit the attribute, 2 -> Developers can only view the attribute, 3 -> Developers cannot see the attribute

Available options:
1,
2,
3
Example:

3

​
DropdownValues
string

Values to display in dropdown options if the attribute type is 2

Example:

"Fleet_management,Cities,EV_management"

​
ValidationRegExp
string

Validation to be applied for string type attributes (type 1)

Example:

"www\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+"

​
AddToKeyMetadata
boolean

Defines if the value of this custom attribute should be injected into the credential's metadata

Example:

true

​
Required
boolean

Defines if the value of this custom attribute is required to create a new object

Example:

true

​
ShowOnSignUp
boolean

Defines if this custom attribute should be displayed in the sign up form

Example:

true

​
WriteOnceReadMany
boolean

If set to true the value is set only once for the first time

Example:

true

​
ID
integer

UID of this custom attribute

Example:

1

​
Type
enum<integer>

custom attribute type: 1 -> String, 2 -> Dropdown, 3 -> Boolean, 4 -> Number

Available options:
1,
2,
3,
4
Example:

2