List access profiles for the specified source app

GET 
/source-apps/:id/access-profiles

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.

This API returns the list of access profiles for the specified source app

Request

Path Parameters

id stringrequired

ID of the source app

Query Parameters

limit int32
Possible values: <= 250
Default value: 250
Max number of results to return. See V3 API Standard Collection Parameters for more information.
Example: 250
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, in
name: eq, in
created: gt, lt, ge, le
modified: gt, lt, ge, le
Example: name eq "developer access profile"

Header Parameters

X-SailPoint-Experimental stringrequired
Default value: true
Use this header to enable this experimental API.
Example: true

Responses

200

List of access profiles for the specified source app

application/json

Schema

Schema

• Array [

id string

The ID of the Access Profile

name string

Name of the Access Profile

description stringnullable

Information about the Access Profile

created date-time

Date the Access Profile was created

modified date-time

Date the Access Profile was last modified.

disabled boolean

Default value: true

Whether the Access Profile is enabled.

requestable boolean

Whether the Access Profile is requestable via access request.

protected boolean

Whether the Access Profile is protected.

ownerId string

The owner ID of the Access Profile

sourceId int64nullable

The source ID of the Access Profile

sourceName string

The source name of the Access Profile

appId int64nullable

The source app ID of the Access Profile

appName stringnullable

The source app name of the Access Profile

applicationId string

The id of the application

type string

The type of the access profile

entitlements string[]

List of IDs of entitlements

entitlementCount int32

The number of entitlements in the access profile

segments string[]

List of IDs of segments, if any, to which this Access Profile is assigned.

approvalSchemes string

Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:

revokeRequestApprovalSchemes string

Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:

requestCommentsRequired boolean

Whether the access profile require request comment for access request.

deniedCommentsRequired boolean

Whether denied comment is required when access request is denied.

accountSelector

object

How to select account when there are multiple accounts for the user

selectors

object[]

nullable

Array [

applicationId string

The application id

accountMatchConfig

object

matchExpression

object

matchTerms

object[]

Array [

name string

The attribute name

value string

The attribute value

op string

The operator between name and value

container boolean

If it is a container or a real match term

and boolean

If it is AND logical operator for the children match terms

children object[]nullable

The children under this match term

]

and boolean

Default value: true

If it is AND operators for match terms

]

• ]

Example (from schema)

[
  {
    "id": "2c91808a7190d06e01719938fcd20792",
    "name": "Employee-database-read-write",
    "description": "Collection of entitlements to read/write the employee database",
    "created": "2021-03-01T22:32:58.104Z",
    "modified": "2021-03-02T20:22:28.104Z",
    "disabled": true,
    "requestable": true,
    "protected": false,
    "ownerId": "9870808a7190d06e01719938fcd20792",
    "sourceId": 10360661,
    "sourceName": "AD Source",
    "appId": 10360661,
    "appName": "mail app",
    "applicationId": "edcb0951812949d085b60cd8bf35bc78",
    "type": "source",
    "entitlements": [
      "2c9180857725c14301772a93bb77242d",
      "c9dc28e148a24d65b3ccb5fb8ca5ddd9"
    ],
    "entitlementCount": 12,
    "segments": [
      "f7b1b8a3-5fed-4fd4-ad29-82014e137e19",
      "29cb6c06-1da8-43ea-8be4-b3125f248f2a"
    ],
    "approvalSchemes": "accessProfileOwner",
    "revokeRequestApprovalSchemes": "accessProfileOwner",
    "requestCommentsRequired": true,
    "deniedCommentsRequired": true,
    "accountSelector": {
      "selectors": [
        {
          "applicationId": "2c91808874ff91550175097daaec161c\"",
          "accountMatchConfig": {
            "matchExpression": {
              "matchTerms": [
                {
                  "name": "",
                  "value": "",
                  "op": null,
                  "container": true,
                  "and": false,
                  "children": [
                    {
                      "name": "businessCategory",
                      "value": "Service",
                      "op": "eq",
                      "container": false,
                      "and": false,
                      "children": null
                    }
                  ]
                }
              ],
              "and": true
            }
          }
        }
      ]
    }
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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 (from schema)

{
  "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

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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 (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

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

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

Loading...