Certifications by IDs

GET 
https://sailpoint.api.identitynow.com/beta/certifications

This API returns a list of certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned.

Request

Query Parameters

reviewer-identitiy string

The ID of reviewer identity. me indicates the current user.

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, in

phase: eq

completed: eq, ne

campaignRef.campaignType: eq, in

campaignRef.id: eq, in

sorters comma-separated

Sort results using the standard syntax described in V3 API Standard Collection Parameters

Sorting is supported for the following fields: name, due, signed

Responses

200

List of certifications

application/json

Schema

Schema

Array [
campaignRef objectrequired
idstringrequired
The unique ID of the campaign.
Example: ef38f94347e94562b5bb8424a56397d8
namestringrequired
The name of the campaign.
Example: Campaign Name
typestringrequired
The type of object that is being referenced.
Possible values: [CAMPAIGN]
Example: CAMPAIGN
campaignTypestringrequired
The type of the campaign.
Possible values: [MANAGER, SOURCE_OWNER, SEARCH]
Example: MANAGER
descriptionstringnullablerequired
The description of the campaign set by the admin who created it.
Example: A description of the campaign
correlatedStatusstringrequired
The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).
Possible values: [CORRELATED, UNCORRELATED]
Example: CORRELATED
mandatoryCommentRequirementstringrequired
Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.
Possible values: [ALL_DECISIONS, REVOKE_ONLY_DECISIONS, NO_DECISIONS]
Example: NO_DECISIONS
phasestringrequired
The current phase of the campaign.
• STAGED: The campaign is waiting to be activated.
• ACTIVE: The campaign is active.
• SIGNED: The reviewer has signed off on the campaign, and it is considered complete.
Possible values: [STAGED, ACTIVE, SIGNED]
Example: ACTIVE
duedate-timerequired
Date and time when the certification is due.
Example: 2018-10-19T13:49:37.385Z
signeddate-timerequired
Date and time when the reviewer signed off on the certification.
Example: 2018-10-19T13:49:37.385Z
reviewer objectrequired
Details of the reviewer for a certification.
typestringrequired
Reviewer's DTO type.
Possible values: [IDENTITY, GOVERNANCE_GROUP]
Example: IDENTITY
idstringrequired
Reviewer's ID.
Example: 2c7180a46faadee4016fb4e018c20642
namestringrequired
Reviewer's display name.
Example: Michael Michaels
emailstringnullable
Reviewing identity's email. This is only applicable to reviewers of the IDENTITY type.
Example: reviewer@test.com
reassignment object
from object
Previous certification.
typestring
DTO type of certification for review.
Possible values: [CERTIFICATION]
Example: IDENTITY
idstring
ID of certification for review.
Example: 7589a83cec4b4f138ce56c1a5ef0756d
namestring
Display name of certification for review.
Example: Manager Access for Michael Michaels
reviewer object
Certification reviewer.
typestringrequired
Reviewer's DTO type.
Possible values: [IDENTITY, GOVERNANCE_GROUP]
Example: IDENTITY
idstringrequired
Reviewer's ID.
Example: 2c7180a46faadee4016fb4e018c20642
namestringrequired
Reviewer's display name.
Example: Michael Michaels
emailstringnullable
Reviewing identity's email. This is only applicable to reviewers of the IDENTITY type.
Example: reviewer@test.com
commentstring
Comments from the previous reviewer.
Example: Please review
hasErrorsbooleanrequired
Indicates whether the certification has any errors.
Example: false
errorMessagestringnullable
Message indicating what the error is.
Example: The certification has an error
completedbooleanrequired
Indicates whether all certification decisions have been made.
Example: false
decisionsMadeint32required
Number of approve/revoke/acknowledge decisions the reviewer has made.
Example: 20
decisionsTotalint32required
Total number of approve/revoke/acknowledge decisions for the certification.
Example: 40
entitiesCompletedint32required
Number of entities (identities, access profiles, roles, etc.) that are complete and all decisions have been made for.
Example: 5
entitiesTotalint32required
Total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete.
Example: 10
]

Example (auto)

[
  {
    "campaignRef": {
      "id": "ef38f94347e94562b5bb8424a56397d8",
      "name": "Campaign Name",
      "type": "CAMPAIGN",
      "campaignType": "MANAGER",
      "description": "A description of the campaign",
      "correlatedStatus": "CORRELATED",
      "mandatoryCommentRequirement": "NO_DECISIONS"
    },
    "phase": "ACTIVE",
    "due": "2018-10-19T13:49:37.385Z",
    "signed": "2018-10-19T13:49:37.385Z",
    "reviewer": {
      "type": "IDENTITY",
      "id": "2c7180a46faadee4016fb4e018c20642",
      "name": "Michael Michaels",
      "email": "reviewer@test.com"
    },
    "reassignment": {
      "from": {
        "type": "IDENTITY",
        "id": "7589a83cec4b4f138ce56c1a5ef0756d",
        "name": "Manager Access for Michael Michaels",
        "reviewer": {
          "type": "IDENTITY",
          "id": "2c7180a46faadee4016fb4e018c20642",
          "name": "Michael Michaels",
          "email": "reviewer@test.com"
        }
      },
      "comment": "Please review"
    },
    "hasErrors": false,
    "errorMessage": "The certification has an error",
    "completed": false,
    "decisionsMade": 20,
    "decisionsTotal": 40,
    "entitiesCompleted": 5,
    "entitiesTotal": 10
  }
]

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: sp:scopes:all

• 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/beta/certifications"
  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/beta

Auth

Bearer Token

Parameters

reviewer-identitiy — query

limit — query

offset — query

count — query

---truefalse

filters — query

sorters — query

ResponseClear

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