--- title: PingOne Identity slug: connectors/pingone-identity docTags: createdAt: 2026-06-09T16:29:48.516Z --- 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](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 |