Sailpoint Identity IQ

This Connector ingests data from the Sailpoint IdentityIQ and integrates it with Swimlane.

Prerequisites

To set up the asset, you need the following inputs:

Username

Password

Capabilities

The Sailpoint IdentityIQ Connector integration provides the following capabilities:

Get Role By ID

Get User By ID

Get Users

API Documentation Link

Sailpoint IdentityIQ API Documentation Link

Configurations

HTTP Basic Authentication

Authenticates using username and password.

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
username	Username	string	Required
password	Password	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Get Role By ID

The Role resource with matching ID or name is returned. Attributes to include in the response can be specified with the 'attributes' query parameter. Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

Endpoint

URL: /Roles/:{{roleId}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.roleId	string	Required	ID or name of Role resource.
parameters.lookupByName	boolean	Optional	A boolean value that determines if the Role resource will be looked up by name instead of Id (value in path parameter 'roleId'). Setting this query parameter to true will cause the value pulled from the 'roleId' path parameter to be treated as a name when searching for the resource.
parameters.attributes	string	Optional	The Role attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Role.
parameters.excludedAttributes	string	Optional	The Role attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Role.

Input Example

{"parameters":{"lookupByName":false,"attributes":"name,type","excludedAttributes":"permits,requirements"},"path_parameters":{"roleId":"c0b4568a4fe7458c434ee77d1fbt156b"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
name	string	Name of the resource
descriptions	array	Output field: descriptions
descriptions.locale	string	Output field: descriptions.locale
descriptions.value	string	Value for the parameter
type	object	Type of the resource
type.iiq	boolean	Type of the resource
type.requirements	boolean	Type of the resource
type.permits	boolean	Type of the resource
type.displayName	string	Name of the resource
type.manualAssignment	boolean	Type of the resource
type.name	string	Name of the resource
type.autoAssignment	boolean	Type of the resource
type.assignmentSelector	boolean	Type of the resource
displayableName	string	Name of the resource
active	boolean	Output field: active
activationDate	string	Date value
deactivationDate	string	Date value
owner	object	Output field: owner
owner.displayName	string	Name of the resource
owner.value	string	Value for the parameter
owner.$ref	string	Output field: owner.$ref
inheritance	array	Output field: inheritance

Output Example

{"status_code":200,"response_headers":{"Date":"Fri, 06 Oct 2023 06:05:14 GMT","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Cache-Control":"no-cache, no-store, private, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff"},"reason":"OK","json_body":{"id":"c0b4568a4fe7458c434ee77d1fbt156b","name":"ADDirect-Production Manager","descriptions":[{}],"type"...

Get User By ID

The User resource with matching id is returned. There are attributes marked as 'returned only by request', such as roles, which must be provided as part of the attributes query parameter in order to be included in the response.

Endpoint

URL: /Users/:{{userId}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.userId	string	Required	The id of User resource. If lookupByName is set to true, this path parameter should be set to the userName of the User.
parameters.attributes	string	Optional	A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.
parameters.excludedAttributes	string	Optional	A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.
parameters.lookupByName	boolean	Optional	A boolean value that determines if the User resource will be looked up by userName instead of userId (value in path parameter 'userId'). Setting this query parameter to true will cause the value pulled from the 'userId' path parameter to be treated as a userName when searching for the resource

Input Example

{"parameters":{"attributes":"name,type","excludedAttributes":"permits,requirements","lookupByName":false},"path_parameters":{"userId":"c0b4568a4fe7458c434ee77d1fbt156b"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
userName	string	Name of the resource
name	object	Name of the resource
name.formatted	string	Name of the resource
name.familyName	string	Name of the resource
name.givenName	string	Name of the resource
displayName	string	Name of the resource
userType	string	Type of the resource
active	boolean	Output field: active
emails	array	Output field: emails
emails.type	string	Type of the resource
emails.value	string	Value for the parameter
emails.primary	string	Output field: emails.primary
urn:ietf:params:scim:schemas:sailpoint:1.0:User	object	Output field: urn:ietf:params:scim:schemas:sailpoint:1.0:User
urn:ietf:params:scim:schemas:sailpoint:1.0:User.accounts	array	Output field: urn:ietf:params:scim:schemas:sailpoint:1.0:User.accounts
urn:ietf:params:scim:schemas:sailpoint:1.0:User.accounts.displayName	string	Name of the resource
urn:ietf:params:scim:schemas:sailpoint:1.0:User.accounts.value	string	Value for the parameter
urn:ietf:params:scim:schemas:sailpoint:1.0:User.accounts.$ref	string	Output field: urn:ietf:params:scim:schemas:sailpoint:1.0:User.accounts.$ref
urn:ietf:params:scim:schemas:sailpoint:1.0:User.entitlements	array	Output field: urn:ietf:params:scim:schemas:sailpoint:1.0:User.entitlements
urn:ietf:params:scim:schemas:sailpoint:1.0:User.entitlements.value	string	Value for the parameter
urn:ietf:params:scim:schemas:sailpoint:1.0:User.entitlements.display	string	Output field: urn:ietf:params:scim:schemas:sailpoint:1.0:User.entitlements.display
urn:ietf:params:scim:schemas:sailpoint:1.0:User.entitlements.type	string	Type of the resource
urn:ietf:params:scim:schemas:sailpoint:1.0:User.entitlements.application	string	Output field: urn:ietf:params:scim:schemas:sailpoint:1.0:User.entitlements.application

Output Example

{"status_code":200,"response_headers":{"Date":"Fri, 06 Oct 2023 06:05:14 GMT","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Cache-Control":"no-cache, no-store, private, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff"},"reason":"OK","json_body":{"id":"c0b4568a4fe7458c434ee77d1fbt156b","userName":"Mock.User","name":{"formatted":"Ms. Barbara J Jense...

Get Users

This endpoint returns all User resources. There are attributes marked as 'returned only by request', such as roles, which must be provided as part of the attributes query parameter in order to be included in the response.

Endpoint

URL: /Users

Method: GET

Input

Argument Name	Type	Required	Description
parameters.filter	string	Optional	Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.
parameters.sortBy	string	Optional	Allows sorting the results by a resource's attributes.
parameters.sortOrder	string	Optional	Determines what order to sort results in.
parameters.startIndex	number	Optional	Determines the starting index of the result set.
parameters.count	number	Optional	Specifies the number of results per page.
parameters.attributes	string	Optional	A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.
parameters.excludedAttributes	string	Optional	A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.

Input Example

{"parameters":{"filter":"string","sortBy":"string","sortOrder":"ascending","startIndex":1,"count":1000,"attributes":"string","excludedAttributes":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
totalResults	string	Result of the operation
startIndex	number	Output field: startIndex
schemas	array	Output field: schemas
Resources	array	Output field: Resources
Resources.id	string	Unique identifier
Resources.userName	string	Name of the resource
Resources.name	object	Name of the resource
Resources.name.formatted	string	Name of the resource
Resources.name.familyName	string	Name of the resource
Resources.name.givenName	string	Name of the resource
Resources.displayName	string	Name of the resource
Resources.userType	string	Type of the resource
Resources.active	boolean	Output field: Resources.active
Resources.emails	array	Output field: Resources.emails
Resources.emails.type	string	Type of the resource
Resources.emails.value	string	Value for the parameter
Resources.emails.primary	string	Output field: Resources.emails.primary
Resources.urn:ietf:params:scim:schemas:sailpoint:1.0:User	object	Output field: Resources.urn:ietf:params:scim:schemas:sailpoint:1.0:User
Resources.urn:ietf:params:scim:schemas:sailpoint:1.0:User.accounts	array	Output field: Resources.urn:ietf:params:scim:schemas:sailpoint:1.0:User.accounts
Resources.urn:ietf:params:scim:schemas:sailpoint:1.0:User.accounts.displayName	string	Name of the resource
Resources.urn:ietf:params:scim:schemas:sailpoint:1.0:User.accounts.value	string	Value for the parameter
Resources.urn:ietf:params:scim:schemas:sailpoint:1.0:User.accounts.$ref	string	Output field: Resources.urn:ietf:params:scim:schemas:sailpoint:1.0:User.accounts.$ref
Resources.urn:ietf:params:scim:schemas:sailpoint:1.0:User.entitlements	array	Output field: Resources.urn:ietf:params:scim:schemas:sailpoint:1.0:User.entitlements

Output Example

{"status_code":200,"response_headers":{"Date":"Fri, 06 Oct 2023 06:05:14 GMT","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Cache-Control":"no-cache, no-store, private, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff"},"reason":"OK","json_body":{"totalResults":"18,","startIndex":1,"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"R...

Response Headers

Header	Description	Example
Cache-Control	Directives for caching mechanisms	no-cache, no-store, private, max-age=0, must-revalidate
Connection	HTTP response header: Connection	keep-alive
Content-Type	The media type of the resource	application/json;charset=UTF-8
Date	The date and time at which the message was originated	Fri, 06 Oct 2023 06:05:14 GMT
Strict-Transport-Security	HTTP response header: Strict-Transport-Security	max-age=31536000
Transfer-Encoding	HTTP response header: Transfer-Encoding	chunked
X-Content-Type-Options	HTTP response header: X-Content-Type-Options	nosniff
X-Frame-Options	HTTP response header: X-Frame-Options	SAMEORIGIN