PhenixID

PSD1148 – SiteVision actions for Identity Provisioning

Fact

  • PhenixID Identity Provisioning 5.2.0 or later

System Requirements

  • Account in SiteVision

Situation

Use PhenixID Identity Provisioning to setup automatic user provisioning from SiteVision.

Solution

This document will show the steps that are necessary to configure Identity Provisioning to automatically provision information to and from SiteVision.

Download

Place the action jar file, SiteVisionActions.jar, in the /actions/customer folder in your PhenixID Identity Provisioning folder.

Common Action Parameters

Multiple actions are included in the package, but they all have some parameters in common.

Parameter

Description

Example

WS URL

[Optional] The URL for SiteVision’s web service.

Default is the value in global parameter SiteVisionWSURL.

https://company.sitevision.se

WS Username

[Optional] The username for SiteVision’s web service.

Default is the value in global parameter SiteVisionWSUsername.

SVUser

WS Password

[Optional] The password for SiteVision’s web service.

Default is the value in global parameter SiteVisionWSPassword.

topSecr3t

Actions for users

SiteVision Add To Object

Version 1.5

Search for objects from SiteVision and add session attributes for the result.

Parameter

Description

Example

Search Endpoint

[Mandatory] The endpoint with the search.

If the value contains SESSION() one search will be made for each object, otherwise only one search will be made.

Supports GLOBAL().

/rest-api/1/0/301.social-4.5/search?query=mail:user@company.com

Attributes

[Optional] Comma separated list of the attributes to create session attributes for.

To rename the attributes, use | to map the attribute name, e.g. SiteVisionAttribute|myAttributeName.

Default: Session attributes will be created for all attributes in the web service response.

fullname|Name,jobtitle|Title

Add Multiple Matches to Multivalue Attribute

[Optional] If the search matches multiple objects, concatenate the values from the objects into multivalue attributes (true) or make attributes from only the first object in the result (false).

Default: false

true

Response Format

[Optional] The format of the response from the web service. Single object or list of objects.

(single/list)

Default: list.

single

No of Simultaneous Calls

[Optional] The action can create multiple threads to create multiple calls to SiteVision’s web service asynchronously. Enter the number of threads to create. Maximum is 100.

Default: 1.

5

Error Attribute Name

[Optional] The name of the error attribute that will be created if any error occurs. This will only apply if search is made once per session object and the existing session objects are to be kept.

Default: errorMessage.

SVError

SiteVision Create SimpleUser

Version 1.7

Create a SimpleUser in SiteVision with attributes from the current session object. If successful, a session attribute named SiteVisionId will be created with the id returned from the web service.

Parameter

Description

Example

Simpleuser Endpoint

[Optional] The endpoint for Simpleuser.

Default is the value in global parameter SiteVisionSimpleUserEndpoint.

/rest-api/1/0/Customer/Principal%20Repository/External%20Repository/simpleuser

External ID Attribute

[Mandatory] The attribute that contains the external ID. This must be a value that will never change.

sourceID

Single String User Properties

[Mandatory] Comma separated list of the attributes with single string values to use for creating a Simpleuser in SiteVision.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

Multi Value String User Properties

[Optional] Comma separated list of the attributes with multi string values to use for creating a Simpleuser in SiteVision.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

Single User Properties

[Mandatory] Comma separated list of the attributes with single non-string values to use for creating a Simpleuser in SiteVision. Using this, the value will not be surrounded by “.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

Multi Value User Properties

[Optional] Comma separated list of the attributes with multi non-string values to use for creating a Simpleuser in SiteVision. Using this, the values will not be surrounded by “.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

Create User Profile

[Optional] If user profile should be created (true) or not (false).

Default: true.

false

No of Simultaneous Calls

[Optional] The action can create multiple threads to create multiple calls to SiteVision’s web service asynchronously. Enter the number of threads to create. Maximum is 100.

Default: 1.

5

Error Attribute Name

[Optional] The name of the error attribute that will be created if any error occurs.

Default: errorMessage.

SVError

SiteVision Get Objects

Version 1.3

Search for objects from SiteVision and create session objects for the result.

Parameter

Description

Example

Search Endpoint

[Mandatory] The endpoint with the search. If the value contains SESSION() one search will be made for each object, otherwise only one search will be made.

Supports GLOBAL().

/rest-api/1/0/301.social-4.5/search?query=mail:user@company.com

Attributes

[Optional] Comma separated list of the attributes to create session attributes for. To rename the attributes, use | to map the attribute name

Default: Session attributes will be created for all attributes in the web service response.

fullname|Name,jobtitle|Title

Attribute to Use for Object Name

[Optional] The attribute from SiteVision to use as Sessionobject Name. If no attribute is specified, an incremental number will be used.

ObjectID

Keep Existing  Session Objects

[Optional] If any existing session objects should be kept (true) or removed (false).

Default value = true.

false

Error Attribute Name

[Optional] The name of the error attribute that will be created if any error occurs. This will only apply if search is made once per session object and the existing session objects are to be kept.

Default: errorMessage

SVError

SiteVision Update SimpleUser

Version 1.6

Update a simpleuser in SiteVision with attributes from the current session object.

Parameter

Description

Example

Update Endpoint

[Mandatory] The endpoint for updating Simpleuser.

Default is the value in global parameter SiteVisionSimpleUserUpdateEndpoint.

/rest-api/1/0/SESSION(backinguser)/properties

Single String User Properties

[Mandatory] Comma separated list of the attributes with single string values to use for updating a Simpleuser in SiteVision.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

Multi Value String User Properties

[Optional] Comma separated list of the attributes with multi string values to use for updating a Simpleuser in SiteVision.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

Single User Properties

[Mandatory] Comma separated list of the attributes with single non-string values to use for updating a Simpleuser in SiteVision. Using this, the value will not be surrounded by “.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

Multi Value User Properties

[Optional] Comma separated list of the attributes with multi non-string values to use for updating a Simpleuser in SiteVision. Using this, the values will not be surrounded by “.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

No of Simultaneous Calls

[Optional] The action can create multiple threads to create multiple calls to SiteVision’s web service asynchronously. Enter the number of threads to create. Maximum is 100.

Default: 1.

5

Error Attribute Name

[Optional] The name of the error attribute that will be created if any error occurs.

Default: errorMessage.

SVError

SiteVision Anonymize User

Version 1.3

Anonymize a user in SiteVision.

Parameter

Description

Example

Anonymize Endpoint

[Mandatory] The endpoint for anonymizing User.

Default is the value in global parameter SiteVisionUserAnonymizeEndpoint.

/rest-api/1/0/2.65fa899f15f15b770c9341_principalRepository/anonymizeuser

Id  Attribute

[Mandatory] The session attribute that contains the user’s SiteVision ID.

siteVisionID

No of Simultaneous Calls

[Optional] The action can create multiple threads to create multiple calls to SiteVision’s web service asynchronously. Enter the number of threads to create. Maximum is 100.

Default: 1.

5

Error Attribute Name

[Optional] The name of the error attribute that will be created if any error occurs.

Default: errorMessage.

SVError

Actions for groups

SiteVision Create CollaborationGroup

Version 1.3

Create a CollaborationGroup in SiteVision with attributes from the current session object. If successful, a session attribute named SiteVisionId will be created with the id returned from the web service.

Parameter

Description

Example

CollaborationGroup Endpoint

[Optional] The endpoint for CollaborationGroup.

Default is the value in global parameter SiteVisionCollaborationGroupEndpoint.

/rest-api/collaborationgroup/

Single String Group Properties

[Mandatory] Comma separated list of the attributes with single string values to use for creating a CollaborationGroup in SiteVision.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

Multi Value String Group Properties

[Optional] Comma separated list of the attributes with multi string values to use for creating a CollaborationGroup in SiteVision.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

Single Group Properties

[Mandatory] Comma separated list of the attributes with single non-string values to use for creating a CollaborationGroup in SiteVision. Using this, the value will not be surrounded by “.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

Multi Value Group Properties

[Optional] Comma separated list of the attributes with multi non-string values to use for creating a CollaborationGroup in SiteVision. Using this, the values will not be surrounded by “.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

No of Simultaneous Calls

[Optional] The action can create multiple threads to create multiple calls to SiteVision’s web service asynchronously. Enter the number of threads to create. Maximum is 100.

Default: 1.

5

Error Attribute Name

[Optional] The name of the error attribute that will be created if any error occurs.

Default: errorMessage.

SVError

SiteVision Update CollaborationGroup

Version 1.3

Update a CollaborationGroup in SiteVision with attributes from the current session object.

Parameter

Description

Example

CollaborationGroup Endpoint

[Optional] The endpoint for CollaborationGroup.

Default is the value in global parameter SiteVisionCollaborationGroupEndpoint.

Supports GLOBAL() and SESSION().

/rest-api/collaborationgroup/SESSION(SiteVisionId)

Single String Group Properties

[Mandatory] Comma separated list of the attributes with single string values to use for updating a CollaborationGroup in SiteVision.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

Multi Value String Group Properties

[Optional] Comma separated list of the attributes with multi string values to use for updating a CollaborationGroup in SiteVision.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

Single Group Properties

[Mandatory] Comma separated list of the attributes with single non-string values to use for updating a CollaborationGroup in SiteVision. Using this, the value will not be surrounded by “.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

Multi Value Group Properties

[Optional] Comma separated list of the attributes with multi non-string values to use for updating a CollaborationGroup in SiteVision. Using this, the values will not be surrounded by “.

Use | to map the session attribute name with the SiteVision property name.

siteVisionProperty|myAttributeName

No of Simultaneous Calls

[Optional] The action can create multiple threads to create multiple calls to SiteVision’s web service asynchronously. Enter the number of threads to create. Maximum is 100.

Default: 1.

5

Error Attribute Name

[Optional] The name of the error attribute that will be created if any error occurs.

Default: errorMessage.

SVError

SiteVision Delete CollaborationGroup

Version 1.2

Delete a CollaborationGroup in SiteVision.

Parameter

Description

Example

CollaborationGroup Endpoint

[Optional] The endpoint for CollaborationGroup.

Default is the value in global parameter SiteVisionCollaborationGroupEndpoint.

Supports GLOBAL() and SESSION().

/rest-api/collaborationgroup/SESSION(SiteVisionId)

No of Simultaneous Calls

[Optional] The action can create multiple threads to create multiple calls to SiteVision’s web service asynchronously. Enter the number of threads to create. Maximum is 100.

Default: 1.

5

Error Attribute Name

[Optional] The name of the error attribute that will be created if any error occurs.

Default: errorMessage.

SVError


DISCLAIMER
Information provided in this document is for your information only. PhenixID makes no explicit or implied claims to the validity of this information. Any trademarks referenced in this document are the property of their respective owners.

The origin of this information may be internal or external to PhenixID. PhenixID makes all reasonable efforts to verify this information.

PhenixID - support.phenixid.se