Users

Get a specified user

GET request returns the specified user.

Path Parameters

Table 1. /api/v3/users/{locator}
Parameter Description

locator

The object resource locator of the requested user.

Request Parameters

Parameter Description

ltk

The authentication token.

fields

Specifies the fields to return in the response. One or more of objects or metadata. Defaults to objects

Response Fields

Path Type Description

data.locator

String

The object resource locator of the requested user.

status

String

Status of the response. One of: OK, ERROR, SKIPPED or ASYNC

data.object.id

String

The identity of the user.

data.object.name

String

The name of the user.

data.object.firstName

String

The first name of the user.

data.object.lastName

String

The last name of the user.

data.object.emailAddress

String

The email address of the user.

data.object.attributes

Array

Custom attributes associated with the user.

data.object.tenant

String

The tenant the user belongs to.

data.object.active

Boolean

true if user is active.

data.object.state

String

One of ACTIVE, DEACTIVATED or DELETED. Deleted user profiles are kept in the system for auditing purposes.

data.object.imported

Boolean

true if user is imported e.g. from LDAP directory.

data.object.principalImportDetails

Null

If user is imported then this will contain details relevant to the import.

data.metadata

Object

Metadata for the resource.

data.metadata.locator

String

The resource locator that uniquely identifies the resource.

data.metadata.createdBy

String

The userid of the user that created the resource.

data.metadata.createdByName

String

The username of the user that created the resource.

data.metadata.createdOn

String

Creation time of resource in ISO-8601 format.

data.metadata.modifiedBy

String

The userid of the user that last modified the resource.

data.metadata.modifiedByName

String

The username of the user that last modified the resource.

data.metadata.modifiedOn

String

Last modification time of resource in ISO-8601 format.

data.metadata.containerLocator

String

The resource locator that uniquely identifies the container resource.

data.metadata.resourceId.objectType

String

The resource type.

data.metadata.resourceId.objectId

String

The resource id.

data.metadata.resourceId.universal

Boolean

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" : "2022-11-25T16:49:04+0000",
      "modifiedBy" : "modified-by-user-Id",
      "modifiedOn" : "2022-11-25T16:49:04+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

container

The container locator of the requested users.

fields

Specifies the fields to return in the response. One or more of objects or metadata. Defaults to objects

filter

An optional FIQL filter expression. Supports searching by the 'name' attribute. For example filter=name=='Object Name'

ltk

The authentication token.

Response Fields

Path Type Description

data.objects[].locator

String

The object resource locator of the requested user.

status

String

Status of the response. One of: OK, ERROR, SKIPPED or ASYNC

data.objects[].object.id

String

The identity of the user.

data.objects[].object.name

String

The name of the user.

data.objects[].object.firstName

String

The first name of the user.

data.objects[].object.lastName

String

The last name of the user.

data.objects[].object.emailAddress

String

The email address of the user.

data.objects[].object.attributes

Array

Custom attributes associated with the user.

data.objects[].object.tenant

String

The tenant the user belongs to.

data.objects[].object.active

Boolean

true if user is active.

data.objects[].object.state

String

One of ACTIVE, DEACTIVATED or DELETED. Deleted user profiles are kept in the system for auditing purposes.

data.objects[].object.imported

Boolean

true if user is imported e.g. from LDAP directory.

data.objects[].object.principalImportDetails

Null

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'&ltk=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"
      }
    } ]
  }
}