REST API for Oracle Identity Governance Self Service

Get Users

get

/iam/governance/selfservice/api/v1/users

Returns all the users in Oracle Identity Manager which are viewable by the logged in user. The users can be filtered based on a criterion specified in the filter query parameter. For example to get all users whose last name starts with 'G' the URI is /users?q=Last::Name sw 'G'. All the attributes of the user including the User Defined Fields (UDF's) are returned as part of the response payload. The response payload can be managed by specifying the attributes of interest in the "fields" query parameter.

Request

Supported Media Types

application/json

Query Parameters

fields: string

Attributes to be returned in the result. Comma-separated attributes are accepted. Sample value for attributes is "First Name, Middle Name, Last Name, Email, User Login, Employee Number, Manager Login, Department Number"
q: string

Search filter to get the records. SCIM filter is accepted. There should not be any spaces for attribute value. If you want to pass space in between attribute values then replace it with "::". Sample value for filter is "User::Login eq avink or Last Name eq kamboj". The filter cannot be applied on the attributes of the contained entity for example we cannot filter users whose manager's Last Name starts with 'Z' i.e. /users?q=Manager.Last::Name sw 'Z'. The fields that are configured searchable can be specified as part of the filter.

Response

Supported Media Types

application/json

200 Response

Successful

Headers

ResponseTime: string

Captures the time in milliseconds taken for processing the request.

Root Schema : UsersListResponse

Type: object

Show Source

count: integer
hasMore: boolean
totalResult: integer
users: array users

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResult":{
            "type":"integer"
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserBulkInstances"
            }
        }
    }
}

Nested Schema : users

Type: array

Show Source

Array of: object UserBulkInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserBulkInstances"
    }
}

Nested Schema : UserBulkInstances

Type: object

Show Source

fields: array fields
id: string
links: array links

{
    "properties":{
        "id":{
            "type":"string"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : fields

Type: array

Show Source

Array of: object Fields

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Fields"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : Fields

Type: object

Show Source

name: string
value: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

href: string
rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error