Users
Add existing user to organization by external ID
Adds an existing user to an organization using your application's external identifier for the user. Use this endpoint when you store users in Scalekit using your own system's identifiers and need to manage their organization memberships without storing Scalekit's internal user ID.
post/api/v1/memberships/organizations/{organization_id}/users:external/{external_id}
Path parameters
organization_idstring required
Unique identifier of the target organization. Must start with 'org_' and be 1-32 characters long.
external_idstring required
External system identifier from connected directories. Must be unique across the system
Query parameters
send_invitation_emailboolean
If true, sends an activation email to the user. Defaults to true.
Request body
Example request
{
"inviter_email": "john.doe@example.com",
"metadata": {
"department": "engineering",
"location": "nyc-office"
},
"roles": [
{
"name": "admin"
}
]
}Response
User successfully added to the organization. Returns details of the updated membership details
Example response
{
"user": {
"email": "user@example.com",
"external_id": "ext_12345a67b89c",
"id": "usr_1234abcd5678efgh",
"memberships": [
{
"display_name": "Acme Corporation",
"metadata": {
"department": "engineering",
"location": "nyc-office"
},
"name": "AcmeCorp",
"organization_id": "org_1234abcd5678efgh",
"permissions": [
"read_projects",
"write_tasks",
"manage_users"
],
"roles": [
{
"display_name": "Dev Team",
"id": "role_79643236410327240",
"name": "team_dev"
}
]
}
],
"metadata": {
"department": "engineering",
"location": "nyc-office"
},
"user_profile": {
"custom_attributes": {
"department": "engineering",
"security_clearance": "level2"
},
"email_verified": true,
"external_identities": [
{
"connection_id": "conn_1234abcd5678efgh",
"connection_type": "OAUTH",
"connection_user_id": "ext_user_12345",
"is_social": true
}
],
"family_name": "Doe",
"gender": "male",
"given_name": "John",
"groups": [
"admin",
"developer"
],
"id": "usr_profile_1234abcd5678efgh",
"locale": "en-US",
"metadata": {
"department": "engineering",
"employee_type": "full-time",
"idp_user_id": "12345"
},
"name": "John Michael Doe",
"phone_number": "+14155552671",
"phone_number_verified": true,
"picture": "https://example.com/avatar.jpg",
"preferred_username": "johndoe"
}
}
}