Anchor
_Toc315972310 _Toc315972310

Anchor
_Toc341972280 _Toc341972280

Reserved Attributes

"id" is a reserved attribute referring to the internal id of an object.

Anchor
_Toc315972311 _Toc315972311

Anchor
_Toc341972281 _Toc341972281

Intrinsic Attributes

Each object has a set of intrinsic attributes that are predefined by the system.

Anchor
_Toc315972312 _Toc315972312

Anchor
_Toc341972282 _Toc341972282

User Defined Attributes

Every object may contain a set of user defined attributes.
Attribute Name should NOT contain whitespace, dash and special characters, but may contain underscore. Attribute Name is case sensitive.
Attribute can be a basic data type, an object or a collection. An attribute can be referenced in the format of "objectName.attributeName". Following are some examples:

• user.id user's ID
• user.domain.id user's domain ID
• role.scopes.domain.id an array of role's domain ID
• policy.options an array of policy options

Anchor
_Toc341972283 _Toc341972283

Attribute Properties

Available attribute types:
STRING, TEXT, BINARY, BOOLEAN, INTEGER, LONG, DOUBLE, FLOAT, DATE, ENUM, PASSWORD, EMAIL, TELEPHONE, URL, OBJECT, COLLECTION
Notes:

1. An attribute must belong to an object. Therefore, every Attribute API must specify the Object's Name.
2. Intrinsic attributes cannot be deleted.

Anchor
_Toc341972284 _Toc341972284

/

Anchor
_Toc315972322 _Toc315972322

attribute/create

To create an attribute. On success, the method returns the internal id of the newly created attribute .
Example: to create an Identity Attribute (aka, User Attribute)
Parameters:
{
"objectName":"user"
"attrs":
{
"identitySource.id":the id of the owner Identity Source,
"name":attribute name,
"type":data type of the attribute
"external":true/false
…
"mapsTo":mapping nameif external
"defaultValue":default value if internal
}
}
Response: {"error":0,"result":{"id":2}}

Anchor
_Toc341972285 _Toc341972285

/

Anchor
_Toc315972323 _Toc315972323

attribute/delete

To delete an identity attribute. On success, the method returns error 0 with no result.
Example: to delete an identity attribute.
Parameters:
{
"objectName":"user",
"id":the id of the attribute to be deleted
}
Response:
{
"error":0,
}

Anchor
_Toc341972286 _Toc341972286

/

Anchor
_Toc315972324 _Toc315972324

attribute/set

To change an identity attribute's properties. On success, the method returns error 0 with no result.
Example: to set an identity attribute's properties.
Parameters:
{
"objectName":"user",
"id":the id of the attribute to be deleted
"attrs":
{
"name":to change the name
"type":data type of the attribute
"external":true/false
…
"mapsTo":mapping name if external
"defaultValue":default value if internal
}
}
Response:
{
"error":0,
}

Anchor
_Toc341972287 _Toc341972287

/

Anchor
_Toc315972325 _Toc315972325

attribute/get

To retrieve an attribute's properties. On success, the method returns the set of properties
Example: to retrieve an identity attribute's properties.
Parameters: 
\{
 "match":
\{
 \["objectName","=", "user"\],
 \["identitySource.id", "=","Identity Source id"\],
  \["name", "=","the name of the attribute to be retrieved"\]
\},
 "return":\["*"\],
\}
Response: 
\{
"error":0,
"result":
\{
 "name":attribute name
 "type":data type of the attribute
 "external":true/false
 …
 "mapsTo":mapping nameif external
 "defaultValue":default value if internal
\}
\}

Anchor
_Toc341972288 _Toc341972288

/

Anchor
_Toc315972326 _Toc315972326

attribute/search

To retrieve a list of attributes of a specified object.
Example: to retrieve a list of identity attributes.
Parameters: 
\{
 "match":
\{
 \["objectName","=", "user"\],
 \["identitySource.id", "=","Identity Source id"\]
\},
 "return":\["name", "type"\],
 "sort":"name",
 "order":"asc",
\}
Response: 
\{
"error":0,
"result":
\[
 \{
 "name":attribute name
 "type":data type of the attribute
\},
 \{
 "name":attribute name
 "type":data type of the attribute
\}
\]
\}
\\
 \\

...