Try this way if you are using postman:
1. API Endpoint
POST http://<your-identityiq-server>/identityiq/scim/v2/LaunchedWorkflows
Make sure to replace <your-identityiq-server> with your actual SailPoint server URL.
2. Headers
In Postman, under the Headers tab, add:
| Key |
Value |
| Content-Type |
application/scim+json |
| Authorization |
Bearer <your_access_token> |
Ensure you replace <your_access_token> with the actual API token or authentication details.
3. JSON Request Body (Example)
Under the Body tab, select raw and use JSON format.
Here’s an example JSON payload:
json
{
"workflowName": "ExampleWorkflow",
"input": [
{
"key": "identityName",
"value": "john.doe"
},
{
"key": "approvalRequired",
"value": "true"
}
]
}
"workflowName" → Replace "ExampleWorkflow" with the actual workflow name."identityName" → Replace "john.doe" with the identity you want to process."approvalRequired" → Example of a boolean input (replace based on your workflow needs).
4. Expected API Responses
Success (201 Created)
json
{
"id": "12345",
"status": "PENDING",
"message": "Workflow started successfully"
}
This means the workflow was launched successfully.
Client Error (400 Bad Request)
json
{
"error": "Missing required input: identityName"
}
This means the API expects an input value you didn’t provide.
Unauthorized (401 Unauthorized)
json
{
"error": "Invalid authentication credentials"
}
This means your API token or authentication method is incorrect.
Server Error (500 Internal Server Error)
json
{
"error": "Workflow execution failed due to unexpected error"
}
This might indicate a configuration or system issue.
5. Testing an Empty Body
If you want to test failure scenarios by sending an empty body, just remove the JSON payload and send the request.
You should get an error like:
json
{
"error": "Missing workflowName"
}
This confirms that the API expects required inputs.
