Skip to main content

PublicIdentitiesApi

Use this API in conjunction with Public Identites Config to enable non-administrators to view identities' publicly visible attributes. With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks.

All URIs are relative to https://sailpoint.api.identitynow.com

MethodHTTP requestDescription
get-public-identities-v1GET /public-identities/v1Get list of public identities
get-public-identities-visible-attributes-v2GET /public-identities/v2/visible-attributesGet public identity visible attributes
search-public-identities-v2POST /public-identities/v2/searchSearch public identities

get-public-identities-v1​

Get list of public identities Get a list of public identities. Set add-core-filters to true to exclude incomplete identities and uncorrelated accounts.

API Spec

Parameters​

NameTypeDescriptionNotes
limitnumberMax number of results to return. See API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset into the full result set. Usually specified with limit to paginate through the results. See API Standard Collection Parameters for more information.[optional] [default to 0]
countbooleanIf true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See API Standard Collection Parameters for more information.[optional] [default to false]
filtersstringFilter results using the standard syntax described in API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq, in alias: eq, sw email: eq, sw firstname: eq, sw lastname: eq, sw[optional] [default to undefined]
addCoreFiltersbooleanIf true, only get identities which satisfy ALL the following criteria in addition to any criteria specified by filters: - Should be either correlated or protected. - Should not be "spadmin" or "cloudadmin". - uid should not be null. - lastname should not be null. - email should not be null.[optional] [default to false]
sortersstringSort results using the standard syntax described in API Standard Collection Parameters Sorting is supported for the following fields: name[optional] [default to undefined]

Return type​

Array<PublicIdentity>

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

import { PublicIdentitiesApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';

const configuration = new Configuration();
const apiInstance = new PublicIdentitiesApi(configuration);
const limit: number = 250; // Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information. (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information. (optional)
const filters: string = firstname eq "John"; // Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **id**: *eq, in*  **alias**: *eq, sw*  **email**: *eq, sw*  **firstname**: *eq, sw*  **lastname**: *eq, sw* (optional)
const addCoreFilters: boolean = false; // If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*:   - Should be either correlated or protected.   - Should not be \&quot;spadmin\&quot; or \&quot;cloudadmin\&quot;.   - uid should not be null.   - lastname should not be null.   - email should not be null. (optional)
const sorters: string = name; // Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **name** (optional)
const result = await apiInstance.getPublicIdentitiesV1({  });
console.log(result);

[Back to top]

get-public-identities-visible-attributes-v2​

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Get public identity visible attributes Returns the default and configured identity attribute keys (with display names) that are allowed for public-identity search and projection. Call this before POST /public-identities/v2/search to learn which field keys are valid in query fields and sort.

Any authenticated user with the default scope can call this endpoint.

API Spec

Parameters​

NameTypeDescriptionNotes
xSailPointExperimentalstringUse this header to enable this experimental API.[optional] [default to 'true']

Return type​

PublicIdentityVisibleAttributes

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

import { PublicIdentitiesApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';

const configuration = new Configuration();
const apiInstance = new PublicIdentitiesApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getPublicIdentitiesVisibleAttributesV2({  });
console.log(result);

[Back to top]

search-public-identities-v2​

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Search public identities Search public identities using a composite query and return matching records.

The root query set combines criteria with AND and must include attributes.identityState.exact = ACTIVE. The field keys must come from GET /public-identities/v2/visible-attributes and may use the prefix "attributes." and/or the suffix ".exact". See the request examples for the required exact payload structure.

Any authenticated user with the default scope can call this endpoint.

API Spec

Parameters​

NameTypeDescriptionNotes
publicIdentitiesSearchRequestPublicIdentitiesSearchRequest
limitnumberMax number of results to return. See API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset into the full result set. Usually specified with limit to paginate through the results. See API Standard Collection Parameters for more information.[optional] [default to 0]
countbooleanIf true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See API Standard Collection Parameters for more information.[optional] [default to false]
xSailPointExperimentalstringUse this header to enable this experimental API.[optional] [default to 'true']

Return type​

Array<PublicIdentityV2>

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

Example​

import { PublicIdentitiesApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { PublicIdentitiesSearchRequest } from '@sailpoint/api-client/dist/public_identities/api';

const configuration = new Configuration();
const apiInstance = new PublicIdentitiesApi(configuration);
const publicIdentitiesSearchRequest: PublicIdentitiesSearchRequest = {
  "indices" : [ "identities" ],
  "sort" : [ "name" ],
  "querySet" : {
    "entries" : [ {
      "queryType" : "TEXT",
      "textQuery" : {
        "fields" : [ "attributes.identityState.exact" ],
        "terms" : [ "ACTIVE" ],
        "matchAny" : false,
        "contains" : false,
        "strict" : true
      }
    } ],
    "matchAny" : false
  },
  "queryType" : "COMPOSITE",
  "includeNested" : false
}; // 
const limit: number = 250; // Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information. (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.searchPublicIdentitiesV2({ publicIdentitiesSearchRequest: publicIdentitiesSearchRequest });
console.log(result);

[Back to top]