PingOne Advanced Identity Cloud - Identity Orchestration (1.0.0)

Download OpenAPI specification:Download

This is the API specification for the Identity Orchestration (workflow) related endpoints and data model for Identity Governance (IGA).

Orchestration

Orchestration endpoints.

Validate script

Use this endpoint to validate the workflow script.

query Parameters
_action
required
string
Example: _action=validate

Only the value of "validate" is supported.

Request Body schema: application/json
script
string

The script to validate.

isExpression
boolean

An expression that can be assigned to a variable. Defaults to false if you don't provide a value.

Responses

Request samples

Content type
application/json
{
  • "script": "string",
  • "isExpression": true
}

Get default script for script task

This endpoint returns the default JavaScript that can be used in script node.

Responses

Response samples

Content type
text/plain
logger.info(\"Creating User/Approval Task\");
var execution = runtimeService.createExecutionQuery().executionId(task.getExecutionId()).singleResult();
var content = execution.getVariables();
var requestId = content.get(\"id\");
var requestIndex = openidm.action(\"iga/governance/requests/\" + requestId, \"GET\", {}, {});"

Get orchestration definitions

Get a list of Orchestration Definitions that are saved to the backend. Orchestration definitions are either in status 'draft' of 'published'. Published orchestration definitions are tied to a request type by id and name. Published orchestration definitions are used by corresponding access request. Draft orchestration definitions can be worked on by end user and publish to backend. The draft orchestration id and name corresponds to the published orchestration defintion id and name.

query Parameters
_pageSize
integer
Example: _pageSize=10

Number of results per page.

_pagedResultsOffset
integer
Example: _pagedResultsOffset=1

Page number of results to show.

_searchAfter
string
Example: _searchAfter=CnoSdGoSc35mb3JnZXJvY2stYXV0b2lkcl4LEgZzdGF0dXMiCXB1Ymxpc2hlZAwLEi5maWVsZGluZy10ZXN0Ml9vcmNoZXN0cmF0aW9uX2RlZmluaXRpb25fbGF0ZXN0IhV0ZXN0UGFyYWxsZUFjY3RDcmVhdGUMGAAgAA==

Page cursor token to be search after. Get this from the response of pervious search response.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalHits": 6,
  • "searchAfterKey": "CoQBEn5qInp1d35mci1zaGQ2OWt3OXU4eWxnYWs4ZWUyd2YxMnF4MTNyWAsSBnN0YXR1cyIJcHVibGlzaGVkDAsSLmF1dG9ub21vdXMtaWFtX29yY2hlc3RyYXRpb25fZGVmaW5pdGlvbl9sYXRlc3QiD0Jhc2ljUm9sZVJlbW92ZQwYACAA"
}

Create and/or Publish Orchestration Definition

Create or publish an an orchestration definition (workflow).

query Parameters
_action
required
string
Enum: "create" "validate" "publish"

Action to be performed for requests endpoint.

Request Body schema: application/json
id
string

ID of the orchestration definition. It must to be one of the 6 seeded definitions.

name
string

Name of the orchestration definition. It must to be one of the 6 seeded definitions.

displayName
string

The name that displays for the orchestration definition.

description
string

The description of the orchestration definition.

type
string
Value: "provisioning"

Provisioning is the only available type.

Array of any

The order of steps. The first element in the steps array is the first step of the workflow.

Responses

Request samples

Content type
application/json
Example
{
  • "id": "BasicApplicationGrant",
  • "name": "BasicApplicationGrant",
  • "displayName": "BasicApplicationGrant",
  • "description": "BasicApplicationGrant access request type.",
  • "type": "provisioning",
  • "steps": [
    ],
  • "staticNodes": {
    }
}

Response samples

Content type
application/json
{
  • "id": "BasicApplicationGrant",
  • "name": "BasicApplicationGrant",
  • "displayName": "BasicApplicationGrant",
  • "description": "BasicApplicationGrant access request type.",
  • "type": "provisioning",
  • "steps": [
    ],
  • "staticNodes": {
    }
}

Update or publish the orchestration (worfklow) definition

Update or publish the orchestration (worfklow) definition.

path Parameters
id
required
string
Request Body schema: application/json
id
string

ID of the orchestration definition. It must to be one of the 6 seeded definitions.

name
string

Name of the orchestration definition. It must to be one of the 6 seeded definitions.

displayName
string

The name that displays for the orchestration definition.

description
string

The description of the orchestration definition.

type
string
Value: "provisioning"

Provisioning is the only available type.

Array of any

The order of steps. The first element in the steps array is the first step of the workflow.

Responses

Request samples

Content type
application/json
{
  • "id": "BasicApplicationGrant",
  • "name": "BasicApplicationGrant",
  • "displayName": "BasicApplicationGrant",
  • "description": "BasicApplicationGrant access request type.",
  • "type": "provisioning",
  • "steps": [
    ],
  • "staticNodes": {
    }
}

Response samples

Content type
application/json
{
  • "id": "BasicApplicationGrant",
  • "name": "BasicApplicationGrant",
  • "displayName": "BasicApplicationGrant",
  • "description": "BasicApplicationGrant access request type.",
  • "type": "provisioning",
  • "steps": [
    ],
  • "staticNodes": {
    }
}

Get Orchestration Definition

Get Orchestration Definition.

path Parameters
id
required
string
status
required
string
Enum: "draft" "published"

Responses

Response samples

Content type
application/json
{
  • "id": "BasicApplicationGrant",
  • "name": "BasicApplicationGrant",
  • "displayName": "BasicApplicationGrant",
  • "description": "BasicApplicationGrant access request type.",
  • "type": "provisioning",
  • "steps": [
    ],
  • "staticNodes": {
    }
}

Delete Orchestration Definition. If the status is published, it will try to delete the workflow model and process defintion in IDM.

Delete Orchestration Definition.

path Parameters
id
required
string
status
required
string
Enum: "draft" "published"

Responses

Response samples

Content type
application/json
{
  • "id": "BasicApplicationGrant",
  • "name": "BasicApplicationGrant",
  • "displayName": "BasicApplicationGrant",
  • "description": "BasicApplicationGrant access request type.",
  • "type": "provisioning",
  • "steps": [
    ],
  • "staticNodes": {
    }
}