Users
Get a specified user
GET
request returns the specified user.
Path Parameters
Parameter | Description |
---|---|
|
The object resource locator of the requested user. |
Request Parameters
Parameter | Description |
---|---|
|
The authentication token. |
|
Specifies the fields to return in the response. One or more of |
Response Fields
Path | Type | Description |
---|---|---|
|
|
The object resource locator of the requested user. |
|
|
Status of the response. One of: |
|
|
The identity of the user. |
|
|
The name of the user. |
|
|
The first name of the user. |
|
|
The last name of the user. |
|
|
The email address of the user. |
|
|
Custom attributes associated with the user. |
|
|
The tenant the user belongs to. |
|
|
|
|
|
One of |
|
|
|
|
|
If user is imported then this will contain details relevant to the import. |
|
|
Metadata for the resource. |
|
|
The resource locator that uniquely identifies the resource. |
|
|
The userid of the user that created the resource. |
|
|
The username of the user that created the resource. |
|
|
Creation time of resource in ISO-8601 format. |
|
|
The userid of the user that last modified the resource. |
|
|
The username of the user that last modified the resource. |
|
|
Last modification time of resource in ISO-8601 format. |
|
|
The resource locator that uniquely identifies the container resource. |
|
|
The resource type. |
|
|
The resource id. |
|
|
True if the resource id is universally addressable. |
Example request
GET /api/v3/users/object:!tenant:defaultTenant~user:user-id?ltk=AUTHENTICATION_TOKEN&fields=object,metadata HTTP/1.1
Host: localhost:8080
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1238
{
"status" : "OK",
"data" : {
"metadata" : {
"createdByName" : "Created By User Name",
"modifiedByName" : "Modified By User Name",
"browsingMetadata" : {
"name" : "User Name",
"description" : "User Name"
},
"locator" : "object:!tenant:defaultTenant~user:user-id",
"containerLocator" : "object:!tenant:defaultTenant",
"createdBy" : "created-by-user-Id",
"createdOn" : "2023-05-31T03:10:09+0000",
"modifiedBy" : "modified-by-user-Id",
"modifiedOn" : "2023-05-31T03:10:09+0000",
"resourceId" : {
"objectType" : "user",
"objectId" : "user-id",
"universal" : false
},
"universalLocator" : null,
"universalContainerLocator" : null
},
"locator" : "object:!tenant:defaultTenant~user:user-id",
"object" : {
"id" : "user-id",
"tenant" : "defaultTenant",
"name" : "User Name",
"imported" : false,
"active" : true,
"state" : "ACTIVE",
"principalImportDetails" : null,
"attributes" : [ "user-attribute-1", "user-attribute-2" ],
"firstName" : "Firstname",
"lastName" : "Lastname",
"emailAddress" : "firstname.lastname@infogix.com"
}
}
}
Get a list of users
GET
request returns the list of users.
Path Parameters
None
Request Parameters
Parameter | Description |
---|---|
|
The container locator of the requested users. |
|
Specifies the fields to return in the response. One or more of |
|
An optional FIQL filter expression. Supports searching by the 'name' attribute. For example |
|
The authentication token. |
Response Fields
Path | Type | Description |
---|---|---|
|
|
The object resource locator of the requested user. |
|
|
Status of the response. One of: |
|
|
The identity of the user. |
|
|
The name of the user. |
|
|
The first name of the user. |
|
|
The last name of the user. |
|
|
The email address of the user. |
|
|
Custom attributes associated with the user. |
|
|
The tenant the user belongs to. |
|
|
|
|
|
One of |
|
|
|
|
|
If user is imported then this will contain details relevant to the import. |
Example request
GET /api/v3/users?container=object:!tenant:defaultTenant~directory:workspace-id&fields=object&filter=name%3D%3D'User%20Name'<k=AUTHENTICATION_TOKEN HTTP/1.1
Host: localhost:8080
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1135
{
"status" : "OK",
"data" : {
"objects" : [ {
"locator" : "object:!tenant:defaultTenant~directory:workspace-id~user:user-id-001",
"object" : {
"id" : "user-id-001",
"tenant" : "defaultTenant",
"name" : "First User",
"imported" : false,
"active" : true,
"state" : "ACTIVE",
"principalImportDetails" : null,
"attributes" : [ "user-attribute-1", "user-attribute-2" ],
"firstName" : "Firstname",
"lastName" : "Lastname",
"emailAddress" : "firstname.lastname@infogix.com"
}
}, {
"locator" : "object:!tenant:defaultTenant~directory:workspace-id~user:user-id-002",
"object" : {
"id" : "user-id-002",
"tenant" : "defaultTenant",
"name" : "Second User",
"imported" : false,
"active" : true,
"state" : "ACTIVE",
"principalImportDetails" : null,
"attributes" : [ "user-attribute-1", "user-attribute-2" ],
"firstName" : "Firstname",
"lastName" : "Lastname",
"emailAddress" : "firstname.lastname@infogix.com"
}
} ]
}
}