Access Summaries

GET /certifications/:id/access-summaries/:type

This API returns a list of access summaries for the specified identity campaign certification and type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.

Request

Path Parameters

id stringrequired

The identity campaign certification ID

Example: ef38f94347e94562b5bb8424a56397d8

type stringrequired

Possible values: [ROLE, ACCESS_PROFILE, ENTITLEMENT]

The type of access review item to retrieve summaries for

Example: ACCESS_PROFILE

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

offset int32

Default value: 0

Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

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.

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:

completed: eq, ne

access.id: eq, in

access.name: eq, sw

entitlement.sourceName: eq, sw

accessProfile.sourceName: eq, sw

Example: access.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: access.name

Example: access.name

Responses

List of access summaries

application/json

Schema
Example (from schema)
Example

Schema

Array [

access

object

type DtoType (string)

Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY, WORKGROUP]

The type of item being certified

id string

The ID of the item being certified

name string

The name of the item being certified

entitlement

object

nullable

id string

The id for the entitlement

name string

The name of the entitlement

description stringnullable

Information about the entitlement

privileged boolean

Indicates if the entitlement is a privileged entitlement

owner

object

nullable

type string

The type can only be IDENTITY. This is read-only.

id string

Identity ID.

name string

Identity's human-readable display name. This is read-only.

email string

Identity's email address. This is read-only.

attributeName string

The name of the attribute on the source

attributeValue string

The value of the attribute on the source

sourceSchemaObjectType string

The schema object type on the source used to represent the entitlement and its attributes

sourceName string

The name of the source for which this entitlement belongs

sourceType string

The type of the source for which the entitlement belongs

sourceId string

The ID of the source for which the entitlement belongs

hasPermissions boolean

Indicates if the entitlement has permissions

isPermission boolean

Indicates if the entitlement is a representation of an account permission

revocable boolean

Indicates whether the entitlement can be revoked

cloudGoverned boolean

True if the entitlement is cloud governed

containsDataAccess boolean

True if the entitlement has DAS data

dataAccess

object

nullable

DAS data for the entitlement

policies

object[]

List of classification policies that apply to resources the entitlement \ groups has access to

Array [

value string

Value of the policy

]

categories

object[]

List of classification categories that apply to resources the entitlement \ groups has access to

Array [

value string

Value of the category

matchCount integer

Number of matched for each category

]

impactScore

object

value string

Impact Score for this data

account

object

nullable

Information about the status of the entitlement

nativeIdentity string

The native identity for this account

disabled boolean

Indicates whether this account is currently disabled

locked boolean

Indicates whether this account is currently locked

type DtoType (string)

An enumeration of the types of DTOs supported within the IdentityNow infrastructure.

id stringnullable

The id associated with the account

name stringnullable

The account name

created date-timenullable

When the account was created

modified date-timenullable

When the account was last modified

activityInsights

object

Insights into account activity

accountID string

UUID of the account

usageDays int32

Possible values: <= 90

The number of days of activity

usageDaysState string

Possible values: [COMPLETE, UNKNOWN]

Status indicating if the activity is complete or unknown

accessProfile

object

id string

The id of the Access Profile

name string

Name of the Access Profile

description string

Information about the Access Profile

privileged boolean

Indicates if the entitlement is a privileged entitlement

cloudGoverned boolean

True if the entitlement is cloud governed

endDate date-timenullable

The date at which a user's access expires

owner

object

nullable

Owner of the Access Profile

type string

The type can only be IDENTITY. This is read-only.

id string

Identity ID.

name string

Identity's human-readable display name. This is read-only.

email string

Identity's email address. This is read-only.

entitlements

object[]

A list of entitlements associated with this Access Profile

Array [

id string

The id for the entitlement

name string

The name of the entitlement

description stringnullable

Information about the entitlement

privileged boolean

Indicates if the entitlement is a privileged entitlement

owner

object

nullable

type string

The type can only be IDENTITY. This is read-only.

id string

Identity ID.

name string

Identity's human-readable display name. This is read-only.

email string

Identity's email address. This is read-only.

attributeName string

The name of the attribute on the source

attributeValue string

The value of the attribute on the source

sourceSchemaObjectType string

The schema object type on the source used to represent the entitlement and its attributes

sourceName string

The name of the source for which this entitlement belongs

sourceType string

The type of the source for which the entitlement belongs

sourceId string

The ID of the source for which the entitlement belongs

hasPermissions boolean

Indicates if the entitlement has permissions

isPermission boolean

Indicates if the entitlement is a representation of an account permission

revocable boolean

Indicates whether the entitlement can be revoked

cloudGoverned boolean

True if the entitlement is cloud governed

containsDataAccess boolean

True if the entitlement has DAS data

dataAccess

object

nullable

DAS data for the entitlement

policies

object[]

List of classification policies that apply to resources the entitlement \ groups has access to

Array [

value string

Value of the policy

]

categories

object[]

List of classification categories that apply to resources the entitlement \ groups has access to

Array [

value string

Value of the category

matchCount integer

Number of matched for each category

]

impactScore

object

value string

Impact Score for this data

account

object

nullable

Information about the status of the entitlement

nativeIdentity string

The native identity for this account

disabled boolean

Indicates whether this account is currently disabled

locked boolean

Indicates whether this account is currently locked

type DtoType (string)

An enumeration of the types of DTOs supported within the IdentityNow infrastructure.

id stringnullable

The id associated with the account

name stringnullable

The account name

created date-timenullable

When the account was created

modified date-timenullable

When the account was last modified

activityInsights

object

Insights into account activity

accountID string

UUID of the account

usageDays int32

Possible values: <= 90

The number of days of activity

usageDaysState string

Possible values: [COMPLETE, UNKNOWN]

Status indicating if the activity is complete or unknown

]

created date-time

Date the Access Profile was created.

modified date-time

Date the Access Profile was last modified.

role

object

nullable

id string

The id for the Role

name string

The name of the Role

description string

Information about the Role

privileged boolean

Indicates if the entitlement is a privileged entitlement

owner

object

nullable

type string

The type can only be IDENTITY. This is read-only.

id string

Identity ID.

name string

Identity's human-readable display name. This is read-only.

email string

Identity's email address. This is read-only.

revocable boolean

Indicates whether the Role can be revoked or requested

endDate date-time

The date when a user's access expires.

accessProfiles

object[]

The list of Access Profiles associated with this Role

Array [

id string

The id of the Access Profile

name string

Name of the Access Profile

description string

Information about the Access Profile

privileged boolean

Indicates if the entitlement is a privileged entitlement

cloudGoverned boolean

True if the entitlement is cloud governed

endDate date-timenullable

The date at which a user's access expires

owner

object

nullable

Owner of the Access Profile

type string

The type can only be IDENTITY. This is read-only.

id string

Identity ID.

name string

Identity's human-readable display name. This is read-only.

email string

Identity's email address. This is read-only.

entitlements

object[]

A list of entitlements associated with this Access Profile

Array [

id string

The id for the entitlement

name string

The name of the entitlement

description stringnullable

Information about the entitlement

privileged boolean

Indicates if the entitlement is a privileged entitlement

owner

object

nullable

type string

The type can only be IDENTITY. This is read-only.

id string

Identity ID.

name string

Identity's human-readable display name. This is read-only.

email string

Identity's email address. This is read-only.

attributeName string

The name of the attribute on the source

attributeValue string

The value of the attribute on the source

sourceSchemaObjectType string

The schema object type on the source used to represent the entitlement and its attributes

sourceName string

The name of the source for which this entitlement belongs

sourceType string

The type of the source for which the entitlement belongs

sourceId string

The ID of the source for which the entitlement belongs

hasPermissions boolean

Indicates if the entitlement has permissions

isPermission boolean

Indicates if the entitlement is a representation of an account permission

revocable boolean

Indicates whether the entitlement can be revoked

cloudGoverned boolean

True if the entitlement is cloud governed

containsDataAccess boolean

True if the entitlement has DAS data

dataAccess

object

nullable

DAS data for the entitlement

policies

object[]

List of classification policies that apply to resources the entitlement \ groups has access to

Array [

value string

Value of the policy

]

categories

object[]

List of classification categories that apply to resources the entitlement \ groups has access to

Array [

value string

Value of the category

matchCount integer

Number of matched for each category

]

impactScore

object

value string

Impact Score for this data

account

object

nullable

Information about the status of the entitlement

nativeIdentity string

The native identity for this account

disabled boolean

Indicates whether this account is currently disabled

locked boolean

Indicates whether this account is currently locked

type DtoType (string)

An enumeration of the types of DTOs supported within the IdentityNow infrastructure.

id stringnullable

The id associated with the account

name stringnullable

The account name

created date-timenullable

When the account was created

modified date-timenullable

When the account was last modified

activityInsights

object

Insights into account activity

accountID string

UUID of the account

usageDays int32

Possible values: <= 90

The number of days of activity

usageDaysState string

Possible values: [COMPLETE, UNKNOWN]

Status indicating if the activity is complete or unknown

]

created date-time

Date the Access Profile was created.

modified date-time

Date the Access Profile was last modified.

]

entitlements

object[]

The list of entitlements associated with this Role

Array [

id string

The id for the entitlement

name string

The name of the entitlement

description stringnullable

Information about the entitlement

privileged boolean

Indicates if the entitlement is a privileged entitlement

owner

object

nullable

type string

The type can only be IDENTITY. This is read-only.

id string

Identity ID.

name string

Identity's human-readable display name. This is read-only.

email string

Identity's email address. This is read-only.

attributeName string

The name of the attribute on the source

attributeValue string

The value of the attribute on the source

sourceSchemaObjectType string

The schema object type on the source used to represent the entitlement and its attributes

sourceName string

The name of the source for which this entitlement belongs

sourceType string

The type of the source for which the entitlement belongs

sourceId string

The ID of the source for which the entitlement belongs

hasPermissions boolean

Indicates if the entitlement has permissions

isPermission boolean

Indicates if the entitlement is a representation of an account permission

revocable boolean

Indicates whether the entitlement can be revoked

cloudGoverned boolean

True if the entitlement is cloud governed

containsDataAccess boolean

True if the entitlement has DAS data

dataAccess

object

nullable

DAS data for the entitlement

policies

object[]

List of classification policies that apply to resources the entitlement \ groups has access to

Array [

value string

Value of the policy

]

categories

object[]

List of classification categories that apply to resources the entitlement \ groups has access to

Array [

value string

Value of the category

matchCount integer

Number of matched for each category

]

impactScore

object

value string

Impact Score for this data

account

object

nullable

Information about the status of the entitlement

nativeIdentity string

The native identity for this account

disabled boolean

Indicates whether this account is currently disabled

locked boolean

Indicates whether this account is currently locked

type DtoType (string)

An enumeration of the types of DTOs supported within the IdentityNow infrastructure.

id stringnullable

The id associated with the account

name stringnullable

The account name

created date-timenullable

When the account was created

modified date-timenullable

When the account was last modified

activityInsights

object

Insights into account activity

accountID string

UUID of the account

usageDays int32

Possible values: <= 90

The number of days of activity

usageDaysState string

Possible values: [COMPLETE, UNKNOWN]

Status indicating if the activity is complete or unknown

]

]

[
  {
    "access": {
      "type": "IDENTITY",
      "id": "2c9180867160846801719932c5153fb7",
      "name": "Entitlement for Company Database"
    },
    "entitlement": {
      "id": "2c918085718230600171993742c63558",
      "name": "CN=entitlement.bbb7c650",
      "description": "Gives read/write access to the company database",
      "privileged": false,
      "owner": {
        "type": "IDENTITY",
        "id": "5168015d32f890ca15812c9180835d2e",
        "name": "Alison Ferguso",
        "email": "[email protected]"
      },
      "attributeName": "memberOf",
      "attributeValue": "CN=entitlement.bbb7c650",
      "sourceSchemaObjectType": "groups",
      "sourceName": "ODS-AD-Source",
      "sourceType": "Active Directory - Direct",
      "sourceId": "78ca6be511cb41fbb86dba2fcca7780c",
      "hasPermissions": false,
      "isPermission": false,
      "revocable": true,
      "cloudGoverned": false,
      "containsDataAccess": true,
      "dataAccess": {
        "policies": [
          {
            "value": "GDPR-20"
          }
        ],
        "categories": [
          {
            "value": "email-7",
            "matchCount": 10
          }
        ],
        "impactScore": {
          "value": "Medium"
        }
      },
      "account": {
        "nativeIdentity": "CN=Alison Ferguso",
        "disabled": false,
        "locked": false,
        "type": "IDENTITY",
        "id": "2c9180857182305e0171993737eb29e6",
        "name": "Alison Ferguso",
        "created": "2020-04-20T20:11:05.067Z",
        "modified": "2020-05-20T18:57:16.987Z",
        "activityInsights": {
          "accountID": "c4ddd5421d8549f0abd309162cafd3b1",
          "usageDays": 45,
          "usageDaysState": "COMPLETE"
        }
      }
    },
    "accessProfile": {
      "id": "2c91808a7190d06e01719938fcd20792",
      "name": "Employee-database-read-write",
      "description": "Collection of entitlements to read/write the employee database",
      "privileged": false,
      "cloudGoverned": false,
      "endDate": "2021-12-25T00:00:00.000Z",
      "owner": {
        "type": "IDENTITY",
        "id": "5168015d32f890ca15812c9180835d2e",
        "name": "Alison Ferguso",
        "email": "[email protected]"
      },
      "entitlements": [
        {
          "id": "2c918085718230600171993742c63558",
          "name": "CN=entitlement.bbb7c650",
          "description": "Gives read/write access to the company database",
          "privileged": false,
          "owner": {
            "type": "IDENTITY",
            "id": "5168015d32f890ca15812c9180835d2e",
            "name": "Alison Ferguso",
            "email": "[email protected]"
          },
          "attributeName": "memberOf",
          "attributeValue": "CN=entitlement.bbb7c650",
          "sourceSchemaObjectType": "groups",
          "sourceName": "ODS-AD-Source",
          "sourceType": "Active Directory - Direct",
          "sourceId": "78ca6be511cb41fbb86dba2fcca7780c",
          "hasPermissions": false,
          "isPermission": false,
          "revocable": true,
          "cloudGoverned": false,
          "containsDataAccess": true,
          "dataAccess": {
            "policies": [
              {
                "value": "GDPR-20"
              }
            ],
            "categories": [
              {
                "value": "email-7",
                "matchCount": 10
              }
            ],
            "impactScore": {
              "value": "Medium"
            }
          },
          "account": {
            "nativeIdentity": "CN=Alison Ferguso",
            "disabled": false,
            "locked": false,
            "type": "IDENTITY",
            "id": "2c9180857182305e0171993737eb29e6",
            "name": "Alison Ferguso",
            "created": "2020-04-20T20:11:05.067Z",
            "modified": "2020-05-20T18:57:16.987Z",
            "activityInsights": {
              "accountID": "c4ddd5421d8549f0abd309162cafd3b1",
              "usageDays": 45,
              "usageDaysState": "COMPLETE"
            }
          }
        }
      ],
      "created": "2021-01-01T22:32:58.104Z",
      "modified": "2021-02-01T22:32:58.104Z"
    },
    "role": {
      "id": "2c91808a7190d06e0171993907fd0794",
      "name": "Accounting-Employees",
      "description": "Role for members of the accounting department with the necessary Access Profiles",
      "privileged": false,
      "owner": {
        "type": "IDENTITY",
        "id": "5168015d32f890ca15812c9180835d2e",
        "name": "Alison Ferguso",
        "email": "[email protected]"
      },
      "revocable": false,
      "endDate": "2021-12-25T00:00:00.000Z",
      "accessProfiles": [
        {
          "id": "2c91808a7190d06e01719938fcd20792",
          "name": "Employee-database-read-write",
          "description": "Collection of entitlements to read/write the employee database",
          "privileged": false,
          "cloudGoverned": false,
          "endDate": "2021-12-25T00:00:00.000Z",
          "owner": {
            "type": "IDENTITY",
            "id": "5168015d32f890ca15812c9180835d2e",
            "name": "Alison Ferguso",
            "email": "[email protected]"
          },
          "entitlements": [
            {
              "id": "2c918085718230600171993742c63558",
              "name": "CN=entitlement.bbb7c650",
              "description": "Gives read/write access to the company database",
              "privileged": false,
              "owner": {
                "type": "IDENTITY",
                "id": "5168015d32f890ca15812c9180835d2e",
                "name": "Alison Ferguso",
                "email": "[email protected]"
              },
              "attributeName": "memberOf",
              "attributeValue": "CN=entitlement.bbb7c650",
              "sourceSchemaObjectType": "groups",
              "sourceName": "ODS-AD-Source",
              "sourceType": "Active Directory - Direct",
              "sourceId": "78ca6be511cb41fbb86dba2fcca7780c",
              "hasPermissions": false,
              "isPermission": false,
              "revocable": true,
              "cloudGoverned": false,
              "containsDataAccess": true,
              "dataAccess": {
                "policies": [
                  {
                    "value": "GDPR-20"
                  }
                ],
                "categories": [
                  {
                    "value": "email-7",
                    "matchCount": 10
                  }
                ],
                "impactScore": {
                  "value": "Medium"
                }
              },
              "account": {
                "nativeIdentity": "CN=Alison Ferguso",
                "disabled": false,
                "locked": false,
                "type": "IDENTITY",
                "id": "2c9180857182305e0171993737eb29e6",
                "name": "Alison Ferguso",
                "created": "2020-04-20T20:11:05.067Z",
                "modified": "2020-05-20T18:57:16.987Z",
                "activityInsights": {
                  "accountID": "c4ddd5421d8549f0abd309162cafd3b1",
                  "usageDays": 45,
                  "usageDaysState": "COMPLETE"
                }
              }
            }
          ],
          "created": "2021-01-01T22:32:58.104Z",
          "modified": "2021-02-01T22:32:58.104Z"
        }
      ],
      "entitlements": [
        {
          "id": "2c918085718230600171993742c63558",
          "name": "CN=entitlement.bbb7c650",
          "description": "Gives read/write access to the company database",
          "privileged": false,
          "owner": {
            "type": "IDENTITY",
            "id": "5168015d32f890ca15812c9180835d2e",
            "name": "Alison Ferguso",
            "email": "[email protected]"
          },
          "attributeName": "memberOf",
          "attributeValue": "CN=entitlement.bbb7c650",
          "sourceSchemaObjectType": "groups",
          "sourceName": "ODS-AD-Source",
          "sourceType": "Active Directory - Direct",
          "sourceId": "78ca6be511cb41fbb86dba2fcca7780c",
          "hasPermissions": false,
          "isPermission": false,
          "revocable": true,
          "cloudGoverned": false,
          "containsDataAccess": true,
          "dataAccess": {
            "policies": [
              {
                "value": "GDPR-20"
              }
            ],
            "categories": [
              {
                "value": "email-7",
                "matchCount": 10
              }
            ],
            "impactScore": {
              "value": "Medium"
            }
          },
          "account": {
            "nativeIdentity": "CN=Alison Ferguso",
            "disabled": false,
            "locked": false,
            "type": "IDENTITY",
            "id": "2c9180857182305e0171993737eb29e6",
            "name": "Alison Ferguso",
            "created": "2020-04-20T20:11:05.067Z",
            "modified": "2020-05-20T18:57:16.987Z",
            "activityInsights": {
              "accountID": "c4ddd5421d8549f0abd309162cafd3b1",
              "usageDays": 45,
              "usageDaysState": "COMPLETE"
            }
          }
        }
      ]
    }
  }
]

[
  {
    "access": {
      "type": "ENTITLEMENT",
      "id": "2c9180857182305e01719937429e2bad",
      "name": "CN=Engineering"
    },
    "entitlement": {
      "id": "2c9180857182305e01719937429e2bad",
      "name": "CN=Engineering",
      "description": "Access to the engineering database",
      "privileged": false,
      "owner": {
        "email": "[email protected]",
        "type": "IDENTITY",
        "id": "2c9180867160846801719932c5153fb7",
        "name": "Brandon Gray"
      },
      "attributeName": "memberOf",
      "attributeValue": "CN=Engineering",
      "sourceName": "ODS-AD-Source",
      "hasPermissions": true,
      "revocable": true,
      "containsDataAccess": true,
      "dataAccess": {
        "policies": [
          {
            "value": "GDPR-1"
          },
          {
            "value": "GDPR-2"
          }
        ],
        "categories": [
          {
            "value": "email-7",
            "matchCount": 74
          },
          {
            "value": "email-9",
            "matchCount": 30
          }
        ],
        "impactScore": {
          "value": "Medium"
        }
      }
    }
  }
]

Client Error - Returned if the request body is invalid.

application/json

Schema
Example (from 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]

text string

Actual text of the error message in the indicated locale.

]

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

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

application/json

Schema
Example (from schema)

Schema

error

A message describing the error

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

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

application/json

Schema
Example (from schema)
403

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]

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]

text string

Actual text of the error message in the indicated locale.

]

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

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

Not Found - returned if the request URL refers to a resource or object that does not exist

application/json

Schema
Example (from schema)
404

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]

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]

text string

Actual text of the error message in the indicated locale.

]

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

{
  "detailCode": "404 Not found",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server did not find a current representation for the target resource."
    }
  ]
}

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

Schema

message

A message describing the error

{
  "message": " Rate Limit Exceeded "
}

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

application/json

Schema
Example (from schema)
500

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]

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]

text string

Actual text of the error message in the indicated locale.

]

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

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

Access Summaries

/certifications/:id/access-summaries/:type

Request​

Path Parameters

Query Parameters

Responses​

Request

Responses