- Available Since API Version – 2.0\
The UidObject type is used to represent users within other fields and entities in Octopus API. UidObject objects contain the following properties:
-
Key - The Key of the UidObject. It may also be used as the Key for the corresponding User entity.\
-
DisplayName - A StringField containing the user’s display name.\
Basic Read Request
The following example illustrates the syntax for a request for the default value of a UidObject in a Read method call.
Request
{
"Creator":1
}
Response
{
"Creator":"VXNlcglNQVNURVI="
}
Detailed Read Request
The following example illustrates the syntax for a request for all properties of a UidObject in a Read method call.
Request
{
"Creator":{
"Key":1,
"DisplayName":1
}
}
Response
{
"Creator":{
"Key":"VXNlcglKTkFQT0xJ",
"DisplayName":"Joe Napoli"
}
}
Create/Update Request
The following example illustrates the syntax for including a UidObject in a Create or Update method call. In this example, the UidObject is represented by the Key passed in the "Write" array of the "SecAccess" object.
Request
{
"SecAccess":{
"Write":[
"VXNlcglNQVNURVI="
]
}
}
Response
{
"SecAccess":{
"Write":[
"VXNlcglNQVNURVI="
]
}
}