Create User Import External Password

POST {{apiPath}}/environments/{{envID}}/users

For user import operations in which the imported user's password remains on the external directory (and is not imported into PingOne), the import action uses the password.external.gateway configuration to designate that the user's authoritative password is managed by an external service.

Note: For passwords with password.external.gateway configured, the user's password status state is set to EXTERNAL.

The POST /environments/{{envID}}/users operation imports a new user resource to the specified environment. This operation uses the application/vnd.pingidentity.user.import+json custom content type in the request header.

New users must be assigned to a population resource identified by its ID, and the request must set a value for the username attribute. The username attribute must be unique to an environment (spanning populations). Access to populations is determined by roles. It's possible that username conflicts may arise, if you or your worker application attempt to create a user that exists in a population to which you have no access.

The password property sets the attributes needed to specify an external directory as the password manager. For this use case, the password property configures the following sub-properties:

Prerequisites

See Users and User Operations for important overview information.
Create a population to get a popID. See Create Population. Run Read All Populations to find an existing population.
Create an LDAP gateway to get a gatewayID. See Create LDAP Gateway. Run Read All Gateways to find an existing gateway.
Create an LDAP gateway to get a userTypeID. See Create LDAP Gateway.

Property	Type	Required?
`password.external`	Object	Required
`password.external.gateway`	Object	Required
`password.external.gateway.id`	UUID	Required
`password.external.gateway.type`	String	Optional
`password.external.gateway.userType`	Reference	Required
`password.external.gateway.userType.id`	UUID	Required
`password.external.gateway.correlationAttributes`	Object	Required

For more information about gateways LDAP data model and gateway user types, see Gateway Management.

Request Body

{"population"=>{"id"=>"{{popID}}"}, "username"=>"myRemoteUser-1", "password"=>{"external"=>{"gateway"=>{"id"=>"{{gatewayID}}", "userType"=>{"id"=>"{{userTypeID}}"}, "correlationAttributes"=>{"uid"=>"{{username}}"}}}}}

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string

RESPONSES

status: Created

{&quot;_links&quot;:{&quot;self&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32&quot;},&quot;environment&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6&quot;},&quot;population&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/f22842c9-f1eb-41a5-8072-20041b609cf1&quot;},&quot;devices&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32/devices&quot;},&quot;roleAssignments&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32/roleAssignments&quot;},&quot;password&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32/password&quot;},&quot;password.reset&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32/password&quot;},&quot;password.set&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32/password&quot;},&quot;password.check&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32/password&quot;},&quot;password.recover&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32/password&quot;},&quot;linkedAccounts&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32/linkedAccounts&quot;},&quot;user.verify&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32&quot;},&quot;account.sendVerificationCode&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32&quot;},&quot;memberOfGroups&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32/memberOfGroups&quot;}},&quot;id&quot;:&quot;01dee5b5-48fa-4a6b-a574-f2ff28ab5b32&quot;,&quot;environment&quot;:{&quot;id&quot;:&quot;abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6&quot;},&quot;account&quot;:{&quot;canAuthenticate&quot;:true,&quot;status&quot;:&quot;OK&quot;},&quot;createdAt&quot;:&quot;2022-06-07T22:48:14.677Z&quot;,&quot;email&quot;:&quot;joe@pingidentity.com&quot;,&quot;enabled&quot;:true,&quot;identityProvider&quot;:{&quot;type&quot;:&quot;PING_ONE&quot;},&quot;lifecycle&quot;:{&quot;status&quot;:&quot;VERIFICATION_REQUIRED&quot;},&quot;mfaEnabled&quot;:false,&quot;name&quot;:{&quot;given&quot;:&quot;Test&quot;,&quot;family&quot;:&quot;User&quot;},&quot;population&quot;:{&quot;id&quot;:&quot;f22842c9-f1eb-41a5-8072-20041b609cf1&quot;},&quot;updatedAt&quot;:&quot;2022-06-07T22:48:14.677Z&quot;,&quot;username&quot;:&quot;import-user_1654642094&quot;,&quot;verifyStatus&quot;:&quot;NOT_INITIATED&quot;}