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 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 expand string optional parameter for get all environments limit number optional parameter for get all environments filter string optional parameter for get all environments output parameter type description status code number http status code of the response reason string response reason phrase links object output field links self object output field self href string output field href embedded object output field embedded environments array output field environments links object output field links self object output field self href string output field href license object output field license href string output field href organization object output field organization href string output field href populations object output field populations href string output field href users object output field users href string output field href applications object output field applications href string output field href activities object output field activities href string output field href branding object output field branding href string output field href features object output field features example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { " links" {}, " embedded" {}, "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 expand string optional parameter for get all group memberships for user limit number optional parameter for get all group memberships for user filter string optional parameter for get all group memberships for user envid string required unique identifier userid string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase links object output field links self object output field self href string output field href embedded object output field embedded groupmemberships array output field groupmemberships links object output field links self object output field self href string output field href user object output field user href string output field href environment object output field environment href string output field href group object output field group href string output field href embedded object output field embedded group object output field group links object output field links id string unique identifier environment object output field environment name string name of the resource description string output field description customdata object response data createdat string output field createdat example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { " links" {}, " embedded" {}, "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 envid string required unique identifier userid string required unique identifier include string required parameter for get all group names for user output parameter type description status code number http status code of the response reason string response reason phrase links object output field links self object output field self href string output field href environment object output field environment href string output field href population object output field population href string output field href devices object output field devices href string output field href roleassignments object output field roleassignments href string output field href password object output field password href string output field href password reset object output field password reset href string output field href password set object output field password set href string output field href password check object output field password check href string output field href password recover object output field password recover href string output field href linkedaccounts object output field linkedaccounts href string output field href example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { " links" {}, "id" "c98fd0cc c34b 406a 9e0b a892edb7a702", "environment" {}, "memberofgroupnames" \[], "createdat" "2020 03 23t19 16 37 492z", "email" "jonnydemo\@example com", "enabled" true, "lifecycle" {}, "mfaenabled" false, "name" {}, "population" {}, "updatedat" "2020 11 20t21 04 28 773z", "username" "jonnydemo" } } ] 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 envid string required unique identifier userid string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase links object output field links self object output field self href string output field href embedded object output field embedded sessions array output field sessions links object output field links self object output field self href string output field href environment object output field environment href string output field href user object output field user href string output field href id string unique identifier environment object output field environment id string unique identifier user object output field user id string unique identifier createdat string output field createdat activeat string output field activeat locations array output field locations at string output field at remoteip string output field remoteip city string output field city example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { " links" {}, " embedded" {}, "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 expand string required parameter for get linked accounts envid string required unique identifier userid string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase links object output field links self object output field self href string output field href embedded object output field embedded linkedaccounts array output field linkedaccounts links object output field links self object output field self href string output field href environment object output field environment href string output field href user object output field user href string output field href id string unique identifier environment object output field environment id string unique identifier user object output field user id string unique identifier identityprovider object unique identifier id string unique identifier externalid string unique identifier count number count value size number output field size example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { " links" {}, " embedded" {}, "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 envid string required unique identifier userid string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase links object output field links self object output field self href string output field href user object output field user href string output field href environment object output field environment href string output field href embedded object output field embedded roleassignments array output field roleassignments links object output field links self object output field self href string output field href user object output field user href string output field href environment object output field environment href string output field href id string unique identifier scope object output field scope id string unique identifier type string type of the resource role object output field role id string unique identifier environment object output field environment example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { " links" {}, " embedded" {}, "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 envid string required unique identifier userid string required unique identifier include string optional parameter for get user by id expand string required parameter for get user by id 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 expand string optional parameter for get users limit number optional parameter for get users filter string optional parameter for get users envid string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase links object output field links self object output field self href string output field href embedded object output field embedded users array output field users links object output field links self object output field self href string output field href password object output field password href string output field href password set object output field password set href string output field href password reset object output field password reset href string output field href password check object output field password check href string output field href password recover object output field password recover href string output field href account sendverificationcode object output field account sendverificationcode href string output field href linkedaccounts object output field linkedaccounts href string output field href embedded object output field embedded example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { " links" {}, " embedded" {}, "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 envid string required unique identifier userid string required unique identifier headers object required http headers for the request content type string required type of the resource unlockat string required parameter for user account lock output parameter type description status code number http status code of the response reason string response reason phrase links object output field links self object output field self href string output field href environment object output field environment href string output field href population object output field population href string output field href devices object output field devices href string output field href roleassignments object output field roleassignments href string output field href password object output field password href string output field href password reset object output field password reset href string output field href password set object output field password set href string output field href password check object output field password check href string output field href password recover object output field password recover href string output field href linkedaccounts object output field linkedaccounts href string output field href example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { " links" {}, "id" "5282e30d 6e05 499c ae68 0069fba776f1", "environment" {}, "account" {}, "createdat" "2023 02 17t20 44 27 905z", "email" "marysample\@example com", "enabled" true, "identityprovider" {}, "lifecycle" {}, "mfaenabled" false, "name" {}, "population" {}, "updatedat" "2023 06 06t22 11 15 401z", "username" "marysample", "verifystatus" "not initiated" } } ] 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 envid string required unique identifier userid string required unique identifier headers object required http headers for the request content type string required type of the resource output parameter type description status code number http status code of the response reason string response reason phrase links object output field links self object output field self href string output field href environment object output field environment href string output field href population object output field population href string output field href devices object output field devices href string output field href roleassignments object output field roleassignments href string output field href password object output field password href string output field href password reset object output field password reset href string output field href password set object output field password set href string output field href password check object output field password check href string output field href password recover object output field password recover href string output field href linkedaccounts object output field linkedaccounts href string output field href example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { " links" {}, "id" "f0a13f5d 3314 49c8 aede 86a059461728", "environment" {}, "account" {}, "createdat" "2022 09 15t15 48 51 428z", "email" "do not send\@example com", "enabled" true, "identityprovider" {}, "lifecycle" {}, "mfaenabled" false, "name" {}, "population" {}, "updatedat" "2022 09 15t15 49 29 368z", "username" "customresource user 1663256931", "verifystatus" "not initiated" } } ] 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 notes api documentation https //apidocs pingidentity com/pingone/platform/v1/api https //apidocs pingidentity com/pingone/platform/v1/api