Import an external IDP user into the platform

POST /api/v1/external-users/import Select code sample Fetch cURL

const url = 'https://localhost:8080/api/v1/external-users/import';const options = {  method: 'POST',  headers: {Authorization: '
  
   ', 'Content-Type': 'application/json'}, body: '{"externalUserId":"example","organizationId":1,"role":"example"}'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}

curl --request POST \  --url https://localhost:8080/api/v1/external-users/import \  --header 'Authorization: 
  
   ' \ --header 'Content-Type: application/json' \ --data '{ "externalUserId": "example", "organizationId": 1, "role": "example" }'

Import an IDP user into the platform database and optionally add them to an organization with a specified role

Authorizations

Section titled “Authorizations ”

BearerAuth
ApiKeyAuth

Request Body

Section titled “Request Body ”

Import user request

Media type application/json object externalUserId required string organizationId integer role string

Example generated

{  "externalUserId": "example",  "organizationId": 1,  "role": "example"}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

User imported successfully

Media type application/json object addedToOrganization integer displayName string email string importedAt string importedFrom string organizationRole string userId string

Example generated

{  "addedToOrganization": 1,  "displayName": "example",  "email": "example",  "importedAt": "example",  "importedFrom": "example",  "organizationRole": "example",  "userId": "example"}