Approve an Approval Item

POST 
https://sailpoint.api.identitynow.com/beta/work-items/:id/approve/:approvalItemId

deprecated

This API has been deprecated, please refer to Approve an Approval Item for latest API.

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

Request

Path Parameters

id stringrequired
The ID of the work item
Example: ef38f94347e94562b5bb8424a56397d8
approvalItemId stringrequired
The ID of the approval item.
Example: 1211bcaa32112bcef6122adb21cef1ac

Responses

200

A work items details object.

application/json

Schema

Schema

idstring
ID of the work item
Example: 2c9180835d2e5168015d32f890ca1581
requesterIdstringnullable
ID of the requester
Example: 2c9180835d2e5168015d32f890ca1581
requesterDisplayNamestringnullable
The displayname of the requester
Example: John Smith
ownerIdstringnullable
The ID of the owner
Example: 2c9180835d2e5168015d32f890ca1581
ownerNamestring
The name of the owner
Example: Jason Smith
createddate-time
Example: 2017-07-11T18:45:37.098Z
modifieddate-timenullable
Example: 2018-06-25T20:22:28.104Z
descriptionstring
The description of the work item
Example: Create account on source 'AD'
statestringnullable
The state of a work item
Possible values: [Finished, Rejected, Returned, Expired, Pending, Canceled, null]
Example: Pending
typestring
The type of the work item
Possible values: [Unknown, Generic, Certification, Remediation, Delegation, Approval, ViolationReview, Form, PolicyViolation, Challenge, ImpactAnalysis, Signoff, Event, ManualAction, Test]
Example: Generic
remediationItems object[]nullable
Array [
idstring
The ID of the certification
Example: 2c9180835d2e5168015d32f890ca1581
targetIdstring
The ID of the certification target
Example: 2c9180835d2e5168015d32f890ca1581
targetNamestring
The name of the certification target
Example: john.smith
targetDisplayNamestring
The display name of the certification target
Example: emailAddress
applicationNamestring
The name of the application/source
Example: Active Directory
attributeNamestring
The name of the attribute being certified
Example: phoneNumber
attributeOperationstring
The operation of the certification on the attribute
Example: update
attributeValuestring
The value of the attribute being certified
Example: 512-555-1212
nativeIdentitystring
The native identity of the target
Example: jason.smith2
]
approvalItems object[]nullable
Array [
idstring
The approval item's ID
Example: 2c9180835d2e5168015d32f890ca1581
accountstringnullable
The account referenced by the approval item
Example: john.smith
applicationstring
The name of the application/source
Example: Active Directory
namestringnullable
The attribute's name
Example: emailAddress
operationstring
The attribute's operation
Example: update
valuestringnullable
The attribute's value
Example: a@b.com
statestringnullable
The state of a work item
Possible values: [Finished, Rejected, Returned, Expired, Pending, Canceled, null]
Example: Pending
]
namestringnullable
The work item name
Example: Account Create
completeddate-timenullable
Example: 2018-10-19T13:49:37.385Z
numItemsintegernullable
The number of items in the work item
Example: 19
errorsstring[]
Example: ["The work item ID that was specified was not found."]
form objectnullable
idstringnullable
ID of the form
Example: 2c9180835d2e5168015d32f890ca1581
namestringnullable
Name of the form
Example: AccountSelection Form
titlestring
The form title
Example: Account Selection for John.Doe
subtitlestring
The form subtitle.
Example: Please select from the following
targetUserstring
The name of the user that should be shown this form
Example: Jane.Doe
sectionsobject[]

Example (auto)

{
  "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": "Pending",
  "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",
      "name": "emailAddress",
      "operation": "update",
      "value": "a@b.com",
      "state": "Pending"
    }
  ],
  "name": "Account Create",
  "completed": "2018-10-19T13:49:37.385Z",
  "numItems": 19,
  "errors": [
    "The work item ID that was specified was not found."
  ],
  "form": {
    "id": "2c9180835d2e5168015d32f890ca1581",
    "name": "AccountSelection Form",
    "title": "Account Selection for John.Doe",
    "subtitle": "Please select from the following",
    "targetUser": "Jane.Doe",
    "sections": [
      {
        "name": "Field1",
        "label": "Section 1",
        "formItems": []
      }
    ]
  }
}

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

404

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

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

404

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

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:work-item:update
user levels: ORG_ADMIN

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

• SDK
• NATIVE

View SDK Reference

package main

import (
  "context"
  "fmt"
  "os"
    "encoding/json"
    beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta"
  sailpoint "github.com/sailpoint-oss/golang-sdk/v2"
)

func main() {
  id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item
  approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item.

  


 	configuration := sailpoint.NewDefaultConfiguration()
  apiClient := sailpoint.NewAPIClient(configuration)
  resp, r, err := apiClient.Beta.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute()
  //resp, r, err := apiClient.Beta.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute()
  if err != nil {
    fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItem``: %v\n", err)
    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
  }
  // response from `ApproveApprovalItem`: WorkItems
  fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItem`: %v\n", resp)
}

Request Collapse all

Base URL

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

Auth

Bearer Token

Parameters

id — pathrequired

approvalItemId — pathrequired

ResponseClear

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