Import an external IDP user into the platform

POST

/api/v1/external-users/import

curl --request POST \
  --url https://localhost:8080/api/v1/external-users/import \
  --header 'Authorization: <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

• BearerAuth
• ApiKeyAuth

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

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"
}

400

Bad Request - Invalid input

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401

Unauthorized

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403

Forbidden - requires Organization Owner role

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

404

User not found in IDP

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

409

Conflict - User already exists in platform

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500

Internal server error

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}