PingOne Identity

the pingone cloud platform helps to integrate every identity service, seamlessly connecting the right users to the right resources prerequisites the pingone asset requires a host url , clientid , clientsecret , and an environmentid to authenticate capabilities this connector provides the following capabilities get all environments get all group memberships for user get all group names for user get all sessions get linked accounts get role assignments get user by id get users user account lock user account unlock notes api documentation https //apidocs pingidentity com/pingone/platform/v1/api configurations pingone authentication configuration parameters parameter description type required url a url to the target host string required clientid client id string required clientsecret client secret string required environmentid environment id string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions get all environments get all environment resources for an organization, a selected set of environments (using a filter), or a specific environment endpoint url v1/environments method get input argument name type required description parameters expand string optional parameters for the get all environments action parameters limit number optional parameters for the get all environments action parameters filter string optional parameters for the get all environments action input example {"parameters" {"expand" "string","limit" 123,"filter" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase links object output field links links self object output field links self links self href string output field links self href embedded object output field embedded embedded environments array output field embedded environments embedded environments links object output field embedded environments links embedded environments links self object output field embedded environments links self embedded environments links self href string output field embedded environments links self href embedded environments links license object output field embedded environments links license embedded environments links license href string output field embedded environments links license href embedded environments links organization object output field embedded environments links organization embedded environments links organization href string output field embedded environments links organization href embedded environments links populations object output field embedded environments links populations embedded environments links populations href string output field embedded environments links populations href embedded environments links users object output field embedded environments links users embedded environments links users href string output field embedded environments links users href embedded environments links applications object output field embedded environments links applications embedded environments links applications href string output field embedded environments links applications href embedded environments links activities object output field embedded environments links activities embedded environments links activities href string output field embedded environments links activities href embedded environments links branding object output field embedded environments links branding embedded environments links branding href string output field embedded environments links branding href embedded environments links features object output field embedded environments links features output example {"status code" 200,"response headers" {},"reason" "ok","json body" {" links" {"self" {}}," embedded" {"environments" \[]},"size" 3}} get all group memberships for user returns all groups that the specified user is a member of endpoint url v1/environments/{{envid}}/users/{{userid}}/memberofgroups method get input argument name type required description parameters expand string optional parameters for the get all group memberships for user action parameters limit number optional parameters for the get all group memberships for user action parameters filter string optional parameters for the get all group memberships for user action path parameters envid string required parameters for the get all group memberships for user action path parameters userid string required parameters for the get all group memberships for user action input example {"parameters" {"expand" "group","limit" 100,"filter" "type eq \\"direct\\""}} output parameter type description status code number http status code of the response reason string response reason phrase links object output field links links self object output field links self links self href string output field links self href embedded object output field embedded embedded groupmemberships array output field embedded groupmemberships embedded groupmemberships links object output field embedded groupmemberships links embedded groupmemberships links self object output field embedded groupmemberships links self embedded groupmemberships links self href string output field embedded groupmemberships links self href embedded groupmemberships links user object output field embedded groupmemberships links user embedded groupmemberships links user href string output field embedded groupmemberships links user href embedded groupmemberships links environment object output field embedded groupmemberships links environment embedded groupmemberships links environment href string output field embedded groupmemberships links environment href embedded groupmemberships links group object output field embedded groupmemberships links group embedded groupmemberships links group href string output field embedded groupmemberships links group href embedded groupmemberships embedded object output field embedded groupmemberships embedded embedded groupmemberships embedded group object output field embedded groupmemberships embedded group embedded groupmemberships embedded group links object output field embedded groupmemberships embedded group links embedded groupmemberships embedded group id string unique identifier embedded groupmemberships embedded group environment object output field embedded groupmemberships embedded group environment embedded groupmemberships embedded group name string name of the resource embedded groupmemberships embedded group description string output field embedded groupmemberships embedded group description embedded groupmemberships embedded group customdata object response data embedded groupmemberships embedded group createdat string output field embedded groupmemberships embedded group createdat output example {"status code" 200,"response headers" {},"reason" "ok","json body" {" links" {"self" {}}," embedded" {"groupmemberships" \[]},"count" 2,"size" 2}} get all group names for user get all group names for user endpoint url v1/environments/{{envid}}/users/{{userid}} method get input argument name type required description path parameters envid string required parameters for the get all group names for user action path parameters userid string required parameters for the get all group names for user action parameters include string required parameters for the get all group names for user action input example {"parameters" {"include" "memberofgroupnames"}} output parameter type description status code number http status code of the response reason string response reason phrase links object output field links links self object output field links self links self href string output field links self href links environment object output field links environment links environment href string output field links environment href links population object output field links population links population href string output field links population href links devices object output field links devices links devices href string output field links devices href links roleassignments object output field links roleassignments links roleassignments href string output field links roleassignments href links password object output field links password links password href string output field links password href links password reset object output field links password reset links password reset href string output field links password reset href links password set object output field links password set links password set href string output field links password set href links password check object output field links password check links password check href string output field links password check href links password recover object output field links password recover links password recover href string output field links password recover href links linkedaccounts object output field links linkedaccounts links linkedaccounts href string output field links linkedaccounts href output example {"status code" 200,"response headers" {},"reason" "ok","json body" {" links" {"self" {},"environment" {},"population" {},"devices" {},"roleassignments" {},"password" {},"password reset" {},"password set" {},"password check" {},"password recover" {},"linkedaccounts" {},"account sendverificationcode" {},"memberofgroups" {}},"id" "c98fd0cc c34b 406a 9e0b a892edb7a702","environment" {"id" "abfba8f6 49eb 49f5 a5d9 80ad5c98f9f6"},"memberofgroupnames" \["managers","training"],"createdat" "2020 03 23t19 get all sessions returns a list of all sessions for the specified user and environment, in descending order based on the session date endpoint url v1/environments/{{envid}}/users/{{userid}}/sessions method get input argument name type required description path parameters envid string required parameters for the get all sessions action path parameters userid string required parameters for the get all sessions action input example {"path parameters" {"envid" "string","userid" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase links object output field links links self object output field links self links self href string output field links self href embedded object output field embedded embedded sessions array output field embedded sessions embedded sessions links object output field embedded sessions links embedded sessions links self object output field embedded sessions links self embedded sessions links self href string output field embedded sessions links self href embedded sessions links environment object output field embedded sessions links environment embedded sessions links environment href string output field embedded sessions links environment href embedded sessions links user object output field embedded sessions links user embedded sessions links user href string output field embedded sessions links user href embedded sessions id string unique identifier embedded sessions environment object output field embedded sessions environment embedded sessions environment id string unique identifier embedded sessions user object output field embedded sessions user embedded sessions user id string unique identifier embedded sessions createdat string output field embedded sessions createdat embedded sessions activeat string output field embedded sessions activeat embedded sessions locations array output field embedded sessions locations embedded sessions locations at string output field embedded sessions locations at embedded sessions locations remoteip string output field embedded sessions locations remoteip embedded sessions locations city string output field embedded sessions locations city output example {"status code" 200,"response headers" {},"reason" "ok","json body" {" links" {"self" {}}," embedded" {"sessions" \[]},"count" 2,"size" 2}} get linked accounts returns the linked accounts for the user resource with the id specified in the request url endpoint url v1/environments/{{envid}}/users/{{userid}}/linkedaccounts method get input argument name type required description parameters expand string required parameters for the get linked accounts action path parameters envid string required parameters for the get linked accounts action path parameters userid string required parameters for the get linked accounts action input example {"parameters" {"expand" "identityproviders"}} output parameter type description status code number http status code of the response reason string response reason phrase links object output field links links self object output field links self links self href string output field links self href embedded object output field embedded embedded linkedaccounts array output field embedded linkedaccounts embedded linkedaccounts links object output field embedded linkedaccounts links embedded linkedaccounts links self object output field embedded linkedaccounts links self embedded linkedaccounts links self href string output field embedded linkedaccounts links self href embedded linkedaccounts links environment object output field embedded linkedaccounts links environment embedded linkedaccounts links environment href string output field embedded linkedaccounts links environment href embedded linkedaccounts links user object output field embedded linkedaccounts links user embedded linkedaccounts links user href string output field embedded linkedaccounts links user href embedded linkedaccounts id string unique identifier embedded linkedaccounts environment object output field embedded linkedaccounts environment embedded linkedaccounts environment id string unique identifier embedded linkedaccounts user object output field embedded linkedaccounts user embedded linkedaccounts user id string unique identifier embedded linkedaccounts identityprovider object unique identifier embedded linkedaccounts identityprovider id string unique identifier embedded linkedaccounts externalid string unique identifier count number count value size number output field size output example {"status code" 200,"response headers" {},"reason" "ok","json body" {" links" {"self" {}}," embedded" {"linkedaccounts" \[]},"count" 1,"size" 1}} get role assignments returns the list of roles assigned to the user identified by the user's id endpoint url v1/environments/{{envid}}/users/{{userid}}/roleassignments method get input argument name type required description path parameters envid string required parameters for the get role assignments action path parameters userid string required parameters for the get role assignments action input example {"path parameters" {"envid" "string","userid" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase links object output field links links self object output field links self links self href string output field links self href links user object output field links user links user href string output field links user href links environment object output field links environment links environment href string output field links environment href embedded object output field embedded embedded roleassignments array output field embedded roleassignments embedded roleassignments links object output field embedded roleassignments links embedded roleassignments links self object output field embedded roleassignments links self embedded roleassignments links self href string output field embedded roleassignments links self href embedded roleassignments links user object output field embedded roleassignments links user embedded roleassignments links user href string output field embedded roleassignments links user href embedded roleassignments links environment object output field embedded roleassignments links environment embedded roleassignments links environment href string output field embedded roleassignments links environment href embedded roleassignments id string unique identifier embedded roleassignments scope object output field embedded roleassignments scope embedded roleassignments scope id string unique identifier embedded roleassignments scope type string type of the resource embedded roleassignments role object output field embedded roleassignments role embedded roleassignments role id string unique identifier embedded roleassignments environment object output field embedded roleassignments environment output example {"status code" 200,"response headers" {},"reason" "ok","json body" {" links" {"self" {},"user" {},"environment" {}}," embedded" {"roleassignments" \[]},"count" 2,"size" 2}} get user by id get data for a single user resource endpoint url v1/environments/{{envid}}/users/{{userid}} method get input argument name type required description path parameters envid string required parameters for the get user by id action path parameters userid string required parameters for the get user by id action parameters include string optional parameters for the get user by id action parameters expand string required parameters for the get user by id action input example {"parameters" {"include" "memberofgroupnames","expand" "population"}} get users returns a list of all user resources for the specified environment endpoint url v1/environments/{{envid}}/users method get input argument name type required description parameters expand string optional parameters for the get users action parameters limit number optional parameters for the get users action parameters filter string optional parameters for the get users action path parameters envid string required parameters for the get users action input example {"parameters" {"expand" "population","limit" 100,"filter" "type eq \\"direct\\""}} output parameter type description status code number http status code of the response reason string response reason phrase links object output field links links self object output field links self links self href string output field links self href embedded object output field embedded embedded users array output field embedded users embedded users links object output field embedded users links embedded users links self object output field embedded users links self embedded users links self href string output field embedded users links self href embedded users links password object output field embedded users links password embedded users links password href string output field embedded users links password href embedded users links password set object output field embedded users links password set embedded users links password set href string output field embedded users links password set href embedded users links password reset object output field embedded users links password reset embedded users links password reset href string output field embedded users links password reset href embedded users links password check object output field embedded users links password check embedded users links password check href string output field embedded users links password check href embedded users links password recover object output field embedded users links password recover embedded users links password recover href string output field embedded users links password recover href embedded users links account sendverificationcode object output field embedded users links account sendverificationcode embedded users links account sendverificationcode href string output field embedded users links account sendverificationcode href embedded users links linkedaccounts object output field embedded users links linkedaccounts embedded users links linkedaccounts href string output field embedded users links linkedaccounts href embedded users embedded object output field embedded users embedded output example {" links" {"self" {"href" "string"}}," embedded" {"users" \[{}]},"count" 123,"size" 123} user account lock user account lock endpoint url v1/environments/{{envid}}/users/{{userid}} method post input argument name type required description path parameters envid string required parameters for the user account lock action path parameters userid string required parameters for the user account lock action headers object required http headers for the request headers content type string required http headers for the request unlockat string optional parameter for user account lock input example {"json body" {"unlockat" "2023 06 07t23 59 59z"},"headers" {"content type" "application/vnd pingidentity account lock+json"}} output parameter type description status code number http status code of the response reason string response reason phrase links object output field links links self object output field links self links self href string output field links self href links environment object output field links environment links environment href string output field links environment href links population object output field links population links population href string output field links population href links devices object output field links devices links devices href string output field links devices href links roleassignments object output field links roleassignments links roleassignments href string output field links roleassignments href links password object output field links password links password href string output field links password href links password reset object output field links password reset links password reset href string output field links password reset href links password set object output field links password set links password set href string output field links password set href links password check object output field links password check links password check href string output field links password check href links password recover object output field links password recover links password recover href string output field links password recover href links linkedaccounts object output field links linkedaccounts links linkedaccounts href string output field links linkedaccounts href output example {"status code" 200,"response headers" {},"reason" "ok","json body" {" links" {"self" {},"environment" {},"population" {},"devices" {},"roleassignments" {},"password" {},"password reset" {},"password set" {},"password check" {},"password recover" {},"linkedaccounts" {},"account unlock" {},"account sendverificationcode" {},"memberofgroups" {}},"id" "5282e30d 6e05 499c ae68 0069fba776f1","environment" {"id" "abfba8f6 49eb 49f5 a5d9 80ad5c98f9f6"},"account" {"canauthenticate"\ false,"lockedat" "2023 user account unlock unlock an account for the user identified by the user id and environment id endpoint url v1/environments/{{envid}}/users/{{userid}} method post input argument name type required description path parameters envid string required parameters for the user account unlock action path parameters userid string required parameters for the user account unlock action headers object required http headers for the request headers content type string required http headers for the request input example {"headers" {"content type" "application/vnd pingidentity account unlock+json"}} output parameter type description status code number http status code of the response reason string response reason phrase links object output field links links self object output field links self links self href string output field links self href links environment object output field links environment links environment href string output field links environment href links population object output field links population links population href string output field links population href links devices object output field links devices links devices href string output field links devices href links roleassignments object output field links roleassignments links roleassignments href string output field links roleassignments href links password object output field links password links password href string output field links password href links password reset object output field links password reset links password reset href string output field links password reset href links password set object output field links password set links password set href string output field links password set href links password check object output field links password check links password check href string output field links password check href links password recover object output field links password recover links password recover href string output field links password recover href links linkedaccounts object output field links linkedaccounts links linkedaccounts href string output field links linkedaccounts href output example {"status code" 200,"response headers" {},"reason" "ok","json body" {" links" {"self" {},"environment" {},"population" {},"devices" {},"roleassignments" {},"password" {},"password reset" {},"password set" {},"password check" {},"password recover" {},"linkedaccounts" {},"account sendverificationcode" {},"memberofgroups" {}},"id" "f0a13f5d 3314 49c8 aede 86a059461728","environment" {"id" "abfba8f6 49eb 49f5 a5d9 80ad5c98f9f6"},"account" {"canauthenticate"\ true,"status" "ok"},"createdat" "2022 09 15 response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt