bulk-approve-approval-item | SailPoint Developer Community

Bulk approve Approval Items

This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.

Path Parameters

id string required
The ID of the work item
Example: ef38f94347e94562b5bb8424a56397d8

Responses

A work items details object.

application/json

Schema
Example (from schema)

Schema

id string
ID of the work item
requesterId string
ID of the requester
requesterDisplayName string
The displayname of the requester
ownerId string
The ID of the owner
ownerName string
The name of the owner
created date-time
modified date-time
description string
The description of the work item
state string
Possible values: [FINISHED, REJECTED, RETURNED, EXPIRED, PENDING, CANCELED]
The state of a work item
type string
Possible values: [UNKNOWN, GENERIC, CERTIFICATION, REMEDIATION, DELEGATION, APPROVAL, VIOLATIONREVIEW, FORM, POLICYVIOLATION, CHALLENGE, IMPACTANALYSIS, SIGNOFF, EVENT, MANUALACTION, TEST]
The type of the work item
remediationItems object
id string
The ID of the certification
targetId string
The ID of the certification target
targetName string
The name of the certification target
targetDisplayName string
The display name of the certification target
applicationName string
The name of the application/source
attributeName string
The name of the attribute being certified
attributeOperation string
The operation of the certification on the attribute
attributeValue string
The value of the attribute being certified
nativeIdentity string
The native identity of the target
approvalItems object
id string
ID of the approval item
account string
The account referenced by the approval item
application string
The name the application/source
attributeName string
The name of the attribute
attributeOperation string
The operation of the attribute
attributeValue string
The value of the attribute
state string
Possible values: [FINISHED, REJECTED, RETURNED, EXPIRED, PENDING, CANCELED]
The state of a work item
name string
The work item name
completed date-time
numItems integer
The number of items in the work item
errors string[]

{
  "id": "2c9180835d2e5168015d32f890ca1581",
  "requesterId": "2c9180835d2e5168015d32f890ca1581",
  "requesterDisplayName": "John Smith",
  "ownerId": "2c9180835d2e5168015d32f890ca1581",
  "ownerName": "Jason Smith",
  "created": "2017-07-11T18:45:37.098Z",
  "modified": "2018-06-25T20:22:28.104Z",
  "description": "Create account on source 'AD'",
  "state": "FINISHED",
  "type": "GENERIC",
  "remediationItems": {
    "id": "2c9180835d2e5168015d32f890ca1581",
    "targetId": "2c9180835d2e5168015d32f890ca1581",
    "targetName": "john.smith",
    "targetDisplayName": "emailAddress",
    "applicationName": "Active Directory",
    "attributeName": "phoneNumber",
    "attributeOperation": "update",
    "attributeValue": "512-555-1212",
    "nativeIdentity": "jason.smith2"
  },
  "approvalItems": {
    "id": "2c9180835d2e5168015d32f890ca1581",
    "account": "john.smith",
    "application": "Active Directory",
    "attributeName": "emailAddress",
    "attributeOperation": "update",
    "attributeValue": "[email protected]",
    "state": "FINISHED"
  },
  "name": "Account Create",
  "completed": "2018-10-19T13:49:37.385Z",
  "numItems": 19,
  "errors": [
    "The work item ID that was specified was not found."
  ]
}

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
locale string
The locale for the message text, a BCP 47 language tag.
localeOrigin string
Possible values: [DEFAULT, REQUEST]
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
locale string
The locale for the message text, a BCP 47 language tag.
localeOrigin string
Possible values: [DEFAULT, REQUEST]
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.

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

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
locale string
The locale for the message text, a BCP 47 language tag.
localeOrigin string
Possible values: [DEFAULT, REQUEST]
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
locale string
The locale for the message text, a BCP 47 language tag.
localeOrigin string
Possible values: [DEFAULT, REQUEST]
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.

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

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

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
locale string
The locale for the message text, a BCP 47 language tag.
localeOrigin string
Possible values: [DEFAULT, REQUEST]
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
locale string
The locale for the message text, a BCP 47 language tag.
localeOrigin string
Possible values: [DEFAULT, REQUEST]
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.

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

An example of a 404 response object

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

Bulk approve Approval Items​

Bulk approve Approval Items