Skip to main content

Cyware Orchestrate

SailPoint IdentityNow

App Vendor: SailPoint

App Category: Authentication

Connector Version: 1.0.0

API Version: v1

About App

SailPoint Technologies provides identity management and governance for unstructured data access.

The SailPoint IdentityNow app is configured with Orchestrate to perform the following actions:

Action Name

Description

List Accounts

This action retrieves a list of accounts.

Get Account Details

This action retrieves the account details.

Get List of Account Activities

This action retrieves a list of account activities.

Update Account

This action updates an account.

Get Account Entitlements

This action returns the entitlements of an account.

Get Account Activity

This action retrieves activities of an account.

Configuration Parameters

The following configuration parameters are required for the SailPoint Identity Now app to communicate with the SailPoint IdentityNow enterprise application. The parameters can be configured by creating instances in the SailPoint IdentityNow app.

Parameter

Description

Field Type

Required/Optional

Comments

Tenant

Enter the tenant of your SailPoint IdentityNow instance.

Example:

If your base URL is "https://sample.api.identitynow.com/" , then the tenant is sample.

Text

Required

JWT token

Enter a JWT token.

Example:

<header.payload.token>

Password

Required

Action: List Accounts

This action retrieves a list of accounts.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Limit

Enter the maximum number of results to be displayed.

Example:

200

Integer

Optional

Default value:

250

Offset

Enter the value for offset.

Example:

0

Integer

Optional

Offset is record based and the index starts at 0.

Default value:

0

Example:

  • offset=0 and limit=20 returns records from 0 to 19.

  • offset=1 and limit=20 returns records from 1 to 20.

Count

Choose to return all records and neglect the values of limit and offset parameter.

Example:

false

Boolean

Optional

Allowed values:

  • true

  • false

Filters

Choose to filter results using the syntax described in SailPoint’s v3 API Standard Collection Parameters.

Example:

name eq "Robert"

Text

Optional

Allowed fields and operators:

  • id: eq, in

  • identityId: eq

  • name: eq, in

  • nativeIdentity: eq, in

  • sourceId: eq, in

  • uncorrelated: eq

Example Request

[
    {
        "limit": 100,
        "offset": 0,
        “count": false
    }
]
Action: Get Account Details

This action retrieves the account details.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Account ID

Enter the account ID.

Example:

"ef38f94347"

Text

Required

You can retrieve Account ID using List Accounts action.

Example Request

[
    {
        "account_id": "ef38f94347"
    }
]
Action: Get List of Account Activities

This action retrieves a list of account activities.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Requested for

Enter the name of target user for whom this activity is requested.

Example:

“John”

Text

Optional

  • This parameter is mutually exclusive with regarding-identity parameter.

  • me indicates the current user.

Requested by

Enter the user name that has requested this activity.

Example:

“me”

Text

Optional

  • This parameter is mutually exclusive with regarding identity parameter.

  • me indicates the current user.

Regarding Identity

Enter the name of either the requester or target user of account activity.

Example:

“me”

Text

Optional

  • This parameter is mutually exclusive with requested for and requested by parameters.

  • me indicates the current user.

Activity Type

Enter the type of account activity.

Example:

“apprequest”

Text

Optional

Limit

Enter the maximum number of results to be displayed.

Example:

200

Integer

Optional

Default value:

250

Offset

Enter the value for offset.

Example:

0

Integer

Optional

Offset is record based and the index starts at 0.

Default value:

0

Example:

  • offset=0 and limit=20 returns records from 0 to 19.

  • offset=1 and limit=20 returns records from 1 to 20.

Count

Choose to return all records and neglect the values of limit and offset parameter.

Example:

false

Boolean

Optional

Allowed values:

  • true

  • false

Filters

Choose to filter results using the syntax described in SailPoint’s v3 API Standard Collection Parameters.

Example:

type eq "ROLE"

Text

Optional

Allowed fields and operators:

  • type: eq, in

  • created: gt, lt, ge, le

  • modified: gt, lt, ge, le

Sorters

Choose to sort results using the syntax described in SailPoint’s v3 API Standard Collection Parameters.

Example:

type

Text

Optional

Allowed keys:

  • type

  • created

  • modified

Example Request

[
    {
       “requester_for”: “John”,
        “requester_by”: “me”,
        “regarding_identity”: “me”,
        “activity_type”: true,       
        “account_id”: "ef38f94347",
        "limit": 100,
        "offset": 0,
        “count”: true
     }
]
Action: Update Account

This action updates an account.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Account ID

Enter the account ID.

Example:

"ef38f94347"

Text

Required

Update Object

Enter the objects and attributes to update.

Example:

$JSON[{“city": "austin","displayname": "john doe","username": "jdoe","samaccountname": "jdoe","mail": "john.doe@sailpoint.com"}]

Key Value

Required

Example Request

[
    {
        “account_id”: "ef38f94347",
        “update_object”: $JSON[{“city": "austin","displayname": "john doe",
                         "username": "jdoe", "samaccountname": "jdoe",
                         "mail": "john.doe@sailpoint.com"}]      
     }
]

Action: Get Account Entitlements

This action retrieves the entitlements of an account. You must have org_admin authority token to perform this action.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Account ID

Enter the account ID.

Example:

"ef38f94347"

Text

Required

Limit

Enter the maximum number of results to be displayed.

Example:

200

Integer

Optional

Offset

Enter the value for offset.

Example:

0

Integer

Optional

Offset is record based and the index starts at 0.

Default value:

0

  • Example:

  • offset=0 and limit=20 returns records from 0 to 19.

  • offset=1 and limit=20 returns records from 1 to 20.

Count

Choose to return all records and neglect the values of limit and offset parameter.

Example:

false

Boolean

Optional

Example Request

[
    {
        “account_id”: "ef38f94347",
        "limit": 100,
        "offset": 0,
        “count": false
     }
]
Action: Get Account Activity

This action retrieves the activities of an account.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Activity ID

Enter the activity ID of an account.

Example:

"ef38f94347"

Text

Required

Example Request

[
    {
        "activity_id": "ef38f94347"
    }
]