Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Anchor
_Toc341972287
_Toc341972287
/
Anchor
_Toc315972325
_Toc315972325
attribute/get


Wiki Markup
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


Wiki Markup
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
\}
\]
\}
\\
 \\