List Identity Profiles

GET 
https://sailpoint.api.identitynow.com/v2024/identity-profiles

Get a list of identity profiles, based on the specified query parameters.

Request

Query Parameters

limit int32
Possible values: <= 250
Max number of results to return. See V3 API Standard Collection Parameters for more information.
Default value: 250
Example: 250
offset int32
Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Default value: 0
Example: 0
count boolean
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=true if that value will not be used.
See V3 API Standard Collection Parameters for more information.
Default value: false
Example: true
filters string
Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
id: eq, ne, ge, gt, in, le, sw
name: eq, ne, ge, gt, in, le, sw
priority: eq, ne
Example: id eq "ef38f94347e94562b5bb8424a56397d8"
sorters comma-separated
Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: id, name, priority, created, modified, owner.id, owner.name
Example: id,name

Responses

200

List of identity profiles.

application/json

Schema

Schema

Array [
idstring
System-generated unique ID of the Object
Example: id12345
namestringnullablerequired
Name of the Object
Example: aName
createddate-time
Creation date of the Object
Example: 2015-05-28T14:07:17Z
modifieddate-time
Last modification date of the Object
Example: 2015-05-28T14:07:17Z
descriptionstringnullable
Identity profile's description.
Example: My custom flat file profile
owner objectnullable
Identity profile's owner.
typestring
Owner's object type.
Possible values: [IDENTITY]
Example: IDENTITY
idstring
Owner's ID.
Example: 2c9180835d191a86015d28455b4b232a
namestring
Owner's name.
Example: William Wilson
priorityint64
Identity profile's priority.
Example: 10
authoritativeSource objectrequired
typestring
Authoritative source's object type.
Possible values: [SOURCE]
Example: SOURCE
idstring
Authoritative source's ID.
Example: 2c9180835d191a86015d28455b4b232a
namestring
Authoritative source's name.
Example: HR Active Directory
identityRefreshRequiredboolean
Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source.
Default value: false
Example: true
identityCountint32
Number of identities belonging to the identity profile.
Example: 8
identityAttributeConfig object
Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.
enabledboolean
Backend will only promote values if the profile/mapping is enabled.
Default value: false
Example: true
attributeTransforms object[]
Array [
identityAttributeNamestring
Identity attribute's name.
Example: email
transformDefinition object
typestring
Transform definition type.
Example: accountAttribute
attributes object
Arbitrary key-value pairs to store any metadata for the object
property name*any
Arbitrary key-value pairs to store any metadata for the object
Example: {"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}
]
identityExceptionReportReference objectnullable
taskResultIduuid
Task result ID.
Example: 2b838de9-db9b-abcf-e646-d4f274ad4238
reportNamestring
Report name.
Example: My annual report
hasTimeBasedAttrboolean
Indicates the value of requiresPeriodicRefresh attribute for the identity profile.
Default value: false
Example: true
]

Example (auto)

[
  {
    "id": "id12345",
    "name": "aName",
    "created": "2015-05-28T14:07:17Z",
    "modified": "2015-05-28T14:07:17Z",
    "description": "My custom flat file profile",
    "owner": {
      "type": "IDENTITY",
      "id": "2c9180835d191a86015d28455b4b232a",
      "name": "William Wilson"
    },
    "priority": 10,
    "authoritativeSource": {
      "type": "SOURCE",
      "id": "2c9180835d191a86015d28455b4b232a",
      "name": "HR Active Directory"
    },
    "identityRefreshRequired": true,
    "identityCount": 8,
    "identityAttributeConfig": {
      "enabled": true,
      "attributeTransforms": [
        {
          "identityAttributeName": "email",
          "transformDefinition": {
            "type": "accountAttribute",
            "attributes": {
              "attributeName": "e-mail",
              "sourceName": "MySource",
              "sourceId": "2c9180877a826e68017a8c0b03da1a53"
            }
          }
        }
      ]
    },
    "identityExceptionReportReference": {
      "taskResultId": "2b838de9-db9b-abcf-e646-d4f274ad4238",
      "reportName": "My annual report"
    },
    "hasTimeBasedAttr": true
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error
A message describing the error
Example: JWT validation failed: JWT is expired

Example (auto)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message
A message describing the error
Example: Rate Limit Exceeded

Example (auto)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Authorization: oauth2

type: Personal Access Token
scopes: idn:identity-profile:read
user levels: ORG_ADMIN
type: Client Credentials
scopes: idn:identity-profile:read

• go
• powershell
  SailPoint SDK
• python
  SailPoint SDK
• csharp
• curl
• dart
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• r
• ruby
• rust
• shell
• swift

• NATIVE

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://sailpoint.api.identitynow.com/v2024/identity-profiles"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer <TOKEN>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

Request Collapse all

Base URL

https://sailpoint.api.identitynow.com/v2024

Auth

Security Scheme

userAuthapplicationAuth

Bearer Token

Parameters

limit — query

offset — query

count — query

---truefalse

filters — query

sorters — query

ResponseClear

Click the Send API Request button above and see the response here!