Retrieves a list of a manager's reportees that belong to a specified tenant and match the search filter criteria.

get https://{tenanturl}/v2.0/Me/reportees

Entitlement required: manageMyOrg (Manage my organization)

This API requires an authenticated user's access token that is generated from an application client during sign-on. This API does not support the use of an API client-generated access token.
Send a valid user access token in the authorization header, by using the bearer authentication scheme.

To improve performance, specify the list of the attributes that you want returned by using the attributes query parameter.

Searching, sorting, paging, and filtering are supported. A maximum of 2500 records are returned for a search query.

Each call to the endpoint returns at most 2,500 reportees. If more reportees exist that were not returned, an additional element called "bookmark" is returned in the response payload. To get the next set of reportees, the caller makes an additional call to the same endpoint, and passes the bookmark value as a query parameter named "nextPage". For example ?nextPage=XASDGAJDGKAWHGI=. The caller continues to make calls to the endpoint until no bookmark element are returned in the response payload, which indicates that all reportees were returned. To use bookmarks, specify useBookmark=true as a query parameter.

Query Params

filter

string

The SCIM compliant search filter. For example, userName eq "john". The filter should be no longer than 4096 characters in length.

attributes

string

The list of attributes that are passed in as comma-separated values that are used when passing the result back to the caller. To improve performance, specify in the list only the attributes that you want returned. If no list is provided, the default action is to return all attributes.

count

string

Specifies the maximum number of query results per page. A negative value is interpreted as 0. A value of 0 indicates that no resource results are to be returned, except for totalResults.

startIndex

string

A 1-based index that indicates the start index that is used when the number of users is returned. A value less than 1 is interpreted as 1.

sortBy

string

Sort the results by the specified criteria when the users are returned.

sortOrder

string

The sorting order when the number of users is returned.

useBookmark

string

Return a bookmark in the response if there are more users to be returned.

string

The bookmark that indicates the next page of users to be returned.

Responses

Response body

object

schemas

array of strings

required

An array of strings that contain the URIs that indicate the namespaces of the SCIM schemas that define the attributes in the current JSON structure. The schema "urn:ietf:params:scim:api:messages:2.0:ListResponse" is returned in the response.

schemas*

totalResults

int32

required

The total number of users that were found that match the specified search criteria for the specified tenant. An upper limit is imposed on this value, in that the total number of users that match the search criteria may be larger than this value. A limit of 2500 users matching the search criteria will be returned.

startIndex

int32

The 1-based index of the first result in the current set of list results.

itemsPerPage

int32

The number of resources that are returned in a list response page.

Resources

array of objects

A list of users.

Resources

object

schemas

array of strings

required

An array of strings that contain the URIs that indicate the namespaces of the SCIM schemas that define the attributes in the current JSON structure. The schemas "urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:ibm:2.0:User" and "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User" are returned in the response.

schemas*

string

required

The unique identifier for the resource as defined by the service. This attribute is read-only and ise sent by the service. Any value that is specified for this attribute in the JSON POST or PUT request payload is ignored.

externalId

string

A unique identifier for the resource that is defined by the provisioning client. It identifies a resource between the provisioning client and the service provider. The client can use a filter to locate the resource with an identifier from the provisioning domain.

meta

object

userName

string

required

The unique identifier for the user that is typically used by the user to directly authenticate to the service provider. It is often displayed to the user as their unique identifier within the system (as opposed to the id or externalId attributes, which are generally opaque and not user-friendly identifiers). Each user must include a non-empty userName value. This identifier must be unique across the service consumer's entire set of users. It must be a stable ID that does not change when the same user is returned in subsequent requests.

title

string

The user's title, such as "Vice President."

name

object

required

displayName

string

The name of the user that is displayed to users. Each user returned may include a non-empty displayName value. Typically it is the full name of the user being described, for example, Babs Jensen or Ms. Barbara J Jensen. However, if that information is unavailable, a username or handle can be used, for example, bjensen. The value is the primary textual label by which this user is normally displayed by the service provider when presenting information to users.

preferredLanguage

string

The language code identifying the preferred language of this identity, for example, en-us or fr-ca.

active

boolean

A Boolean value that indicates the user's administrative status. The definitive meaning of this attribute is determined by the service provider. For example, a value of true indicates that the user can, log in, while a value of false indicates that the user's account has been suspended. If not specified, the value defaults to true.

emails

array of objects

required

A list of email addresses that are associated with the user. Only one is supported.

emails*

object

value

string

required

The e-mail addresses for the user. The value is canonicalized by the service provider. For example, bjensen@example.com instead of bjensen@EXAMPLE.COM. Must be RFC 2822 compliant. Maximum length is 128 characters.

type

string

required

A label that indicates the attribute function; for example, "work". Only a single email is allowed.

work

addresses

array of objects

required

A list of addresses that are associated with the user.

addresses*

object

locality

string

The city or locality component. Maximum length is 128 characters.

country

string

The country name component. Maximum length is 128 characters.

type

string

A label that indicates the attribute's function; for example, "work" or "home".

work

streetAddress

string

The street address. Maximum length is 128 characters.

postalCode

string

The postal code. Maximum length is 40 characters.

formatted

string

The formatted value of the address. Maximum length is 500 characters.

primary

boolean

Indicates whether this is address is the primary address for correspondence.

region

string

The region. Maximum length is 128 characters.

phoneNumbers

array of objects

A list of phone numbers that are associated with the user.

phoneNumbers

object

value

string

required

A list of phone numbers that are associated with the user. The value is be canonicalized by the service provider according to format in RFC3966, for example, "tel:+1-201-555-0123". Canonical type values are work, home, mobile, fax, and pager. Maximum length is 32 characters.

type

string

required

A label that indicates the attribute's function; for example, "work" or "home".

work home mobile pager fax

urn:ietf:params:scim:schemas:extension:ibm:2.0:User

object

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

object

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://tenant_url/v2.0/Me/reportees \
3
     --header 'accept: application/scim+json'

Choose an example:

application/scim+json

200The operation was successful.

400The request was incorrect.

403Forbidden.

500An internal server error occurred.

529The request timed out.