Saviynt Connector ¶
Author: Ping Identity
Introduction ¶
Saviynt connector can be used for account creation and provisioning for users created in Saviynt account. This connector allows you to:
- Create User
- Update User
- Get Account Details
- Update User Request
- Fetch Request History
- Approve-Reject Request
- Get Request Approval Details
- Get Pending Requests
- Create user request with approval
- Remove Role
- Get Role Details
- Add Role
- Inactive user
- Get User Details
Setup ¶
Resources ¶
For information and setup help, see the following sections of the Saviynt API documentation:
- Get Authorization Token
- Create User
- Update User
- Get Account Details
- Update User Request
- Get Request approval details
- Get Pending Requests
- Get Role Details
- Add Role
- Inactive User
- Get User Details
Requirements ¶
To use the connector, you'll need:
- Saviynt Admin User Account Access
- Saviynt API Domain url and path
Setting up the connector ¶
In Davinci, add a Saviynt User Non-Approval Flow connection via the "Connections" tab in your Davinci Environment. For help, see Adding a connection.
Connector Settings ¶
Once you've added the Saviynt User Non-Approval Flow connection click on it's logo, or click the "···" button and edit. You will see the connector's details pop-up. On the GENERAL tab, enter in your Saviynt account details below to get Authorization Token
- Saviynt Domain url
- Saviynt Path
- Saviynt Admin Username
- Saviynt Admin Password
and click apply. This ensures that whenever you use this connector you will not have to reenter this information and username and password is used for generated Token passed as input to Authorise below connector in flow.
Using the connector in a flow ¶
Create User ¶
To create user in the savinyt add a Saviynt connector in the flow studio. Then choose the Create User capability. Provide the input parameters to be updated from previous nodes in the flow (HTML form) and submit the details.
Update user details ¶
To update user attributes saved in the savinyt add a Saviynt connector in the flow studio. Then choose the Update User capability. Provide the input parameters to be updated from previous nodes in the flow (HTML form) and submit the details.
Get Account Details ¶
To get account details of user in the savinyt add a Saviynt connector in the flow studio. Then choose the Get account details capability. Provide the input parameters to be updated from previous nodes in the flow (HTML form) and submit the details.
Update User Request ¶
To update user request in the savinyt add a Saviynt connector in the flow studio. Then choose the Update User Request capability. Provide the input parameters to be updated from previous nodes in the flow (HTML form) and submit the details.
Fetch Request History ¶
To fetch request history in the savinyt add a Saviynt connector in the flow studio. Then choose the Fetch Request History capability. Provide the input parameters to be updated from previous nodes in the flow (HTML form) and submit the details.
Approve-Reject Request ¶
To get the lists the existing user details based on search parameter provided add a Saviynt connector in the flow studio. Then choose the userdetails capability. Provide the parameters from previous nodes in the flow (HTML form) to retrieve the list of users based on filter criteria/username submitted.
Get Request Approval Details ¶
To Get Request Approval Details saved in the savinyt add a Saviynt User Approval Flow connector in the flow studio. Then choose the Get Request Approval Details capability. Provide the input parameters to be updated from previous nodes in the flow (HTML form) and submit the details.
Get Pending Requests ¶
To inactivate the exsting savinyt user add a Saviynt connector in the flow studio. Then choose the Inactivate User capability. Provide the username parameters from previous nodes in the flow (HTML form) to modify the user status.
Create User with approval ¶
To create user in the savinyt add a Saviynt User Approval Flow connector in the flow studio. Then choose the Create User capability. Provide the input parameters to be updated from previous nodes in the flow (HTML form) and submit the details.
Remove Role ¶
To remove role added for an existing saviynt user add a Saviynt connector in the flow studio. Then choose the Remove Role capability. Provide the input parameters(username & rolename) from previous nodes in the flow (HTML form) and submit the details.
Get Role Details ¶
To get role details saved add a Saviynt connector in the flow studio. Then choose the Get Role Details For User capability. Provide the input parameters from previous nodes in the flow (HTML form) and submit the details.
Add Role ¶
To add role to the existing saviynt user add a Saviynt connector in the flow studio. Then choose the Add role to an user capability. Provide the input parameters(username & rolename) from previous nodes in the flow (HTML form) and submit the details.
Inactive user ¶
To inactivate the exsting savinyt user add a Saviynt connector in the flow studio. Then choose the Inactivate User capability. Provide the username parameters from previous nodes in the flow (HTML form) to modify the user status.
Get User Details ¶
To get the lists the existing user details based on search parameter provided add a Saviynt connector in the flow studio. Then choose the userdetails capability. Provide the parameters from previous nodes in the flow (HTML form) to retrieve the list of users based on filter criteria/username submitted.
Capabilities ¶
Create User (createUser) ¶
Create an user in saviynt
First Name textField
required
¶
First Name of the user
Middle Name textField
¶
Provide your middle name
Username textField
required
¶
username for the create user
Last Name textField
required
¶
Last Name of the user
Email textField
required
¶
Email of the user
Employee Type dropdownWithCreate
¶
Select any employee type
- Tester
- Manager
- TeamLead
- Developer
Start Date textField
required
¶
Start Date of the user
End Date textField
required
¶
Provide last date of the user
City textField
¶
Provide your city name
State textField
¶
Provide your state name
Phone Number textField
¶
Provide your phone number
Country textField
¶
Provide your country name
Company Name textField
¶
Provide your company name
Other Attributes variableInputList
¶
Add other attributes and their values.
Update User (updateUser) ¶
Update an user in saviynt
First Name textField
required
¶
First Name of the user
Middle Name textField
¶
Provide your middle name
Username textField
required
¶
username for the create user
Last Name textField
required
¶
Last Name of the user
StatusKey toggleSwitch
¶
Statuskey of the user
Email textField
required
¶
Email of the user
Employee Type dropdownWithCreate
¶
Select any employee type
- Tester
- Manager
- TeamLead
- Developer
Start Date textField
required
¶
Start Date of the user
End Date textField
required
¶
Provide last date of the user
City textField
¶
Provide your city name
State textField
¶
Provide your state name
Phone Number textField
¶
Provide your phone number
Country textField
¶
Provide your country name
Company Name textField
¶
Provide your company name
Other Attributes variableInputList
¶
Add other attributes and their values.
Inactivate User (inactivateUser) ¶
Inactivate an user in saviynt
Username textField
required
¶
username for the create user
Get User Details (getUserDetails) ¶
Get an user details from saviynt
Username textField
required
¶
username for the create user
Response Fields textField
¶
User attributes which you want to see in the response
Filter Criteria textField
¶
User fields based on which you want to get the user attribute details(including userkey)
Search Criteria textField
¶
search for a user based on the string passed (eg - “ab” or “ab” or “ab”) in their firstname, lastname, displayname and username only, example - "ab*" - This will return all users with firstname or lastname or username starting with "ab"
Advance Search Criteria textField
¶
search for a user based on the string passed (eg - “ab” or “ab” or “ab”), example - {"username":"a", "firstname":"b"} - This will return all users with username starting with "a" AND firstname ending with "b". Exact match search is applicable for types boolean, users, customer. Date can be entered in format - yyyy-MM-dd.
Maximum number of requests textField
¶
Maximum number of requests
Offset textField
¶
Offset
Sort textField
¶
Sort
Order textField
¶
asc/desc
Manager textField
required
¶
Manager of the user
Show Security Answers textField
¶
"0"/"1" to display encrypted security answers for the user
Add Role To User (addRoleToUser) ¶
This will add existing role to an user
Username textField
required
¶
username for the create user
Role Name textField
required
¶
Provide a role name
Get Role Details Of User (getRoleDetailsOfUser) ¶
This will fetch all roles of an user
Username textField
required
¶
username for the create user
Remove Role From User (removeRoleFromUser) ¶
This will remove role from an user
Username textField
required
¶
username for the create user
Role Name textField
required
¶
Provide a role name
Create User With Approval (createUserWithApproval) ¶
Create User
First Name textField
required
¶
First Name of the user
Last Name textField
required
¶
Last Name of the user
Roles textField
required
¶
Roles of the user
Employee Type dropdownWithCreate
¶
Select any employee type
- Tester
- Manager
- TeamLead
- Developer
Start Date textField
required
¶
Start Date of the user
Status toggleSwitch
required
¶
Status of the user
StatusKey toggleSwitch
¶
Statuskey of the user
Manager textField
required
¶
Manager of the user
Email textField
required
¶
Email of the user
System Username textField
required
¶
System username of the user
Enabled textField
required
¶
To enable disable the user
Username textField
required
¶
username for the create user
Get Pending Requests (getPendingRequests) ¶
Get Pending Requests
Maximum number of requests textField
¶
Maximum number of requests
Request Key textField
required
¶
Request Key of the pending request
Get Request Approval Details (getRequestApprovalDetails) ¶
Get Request Approval Details
Request Key textField
required
¶
Request Key of the pending request
Approve-Reject Request (approveRejectRequest) ¶
Approve-Reject Request
Request Key textField
required
¶
Request Key of the pending request
Request ID textField
required
¶
Request ID of pending request to approve/reject
Request Action textField
required
¶
it will take the value either 1 or 2 for approve/reject respectively
Comments textField
¶
Comments by approver for particular request
Fetch Request History (fetchRequestHistory) ¶
Fetch Request History
Status toggleSwitch
required
¶
Status of the user
Maximum number of requests textField
¶
Maximum number of requests
Update User Request (updateUserRequest) ¶
Update User Request
Username textField
required
¶
username for the create user
First Name textField
required
¶
First Name of the user
Last Name textField
required
¶
Last Name of the user
Designation textField
¶
Provide designation
Manager textField
required
¶
Manager of the user
Get Account Details (getAccountDetails) ¶
Get Account Details
Status toggleSwitch
required
¶
Status of the user
Name textField
¶
Provide your name
Type textField
required
¶
Provide type
Value textField
¶
Provide value
Rank textField
¶
Provide rank
Limitations ¶
Use of connector is limited by the availability of Saviynt API and account access.