Skip to main content
POST
/
api
/
v1
/
organizations
/
{org_id}
/
users_auto_registration
Onboard Users
curl --request POST \
  --url https://anaconda.com/api/v1/organizations/{org_id}/users_auto_registration \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_emails": [
    "jsmith@example.com"
  ]
}
'
{
  "users_in_onboarding_process": [
    "<string>"
  ],
  "users_unavailable_for_onboarding": [
    "<string>"
  ],
  "total_organization_seats": "<string>",
  "available_organization_seats": "<string>"
}
Administrators receive an email confirming the users were added. Users receive a welcome email and a separate email containing their organization access token.
If a user already has an Anaconda account associated with their email address, automated onboarding will fail for that user.If the number of available seats is less than the number of users you are attempting to add, users are added until seats are no longer available, and remaining users appear in users_unavailable_for_onboarding.

Authorizations

​
Authorization
string
header
required

Bearer token obtained by authenticating with service account credentials (client_id and client_secret).

See the Getting started page for the full authentication flow.

Path Parameters

​
org_id
string
required

Your organization ID, found in your organization's URL: anaconda.com/app/organizations/<ORG_ID>/.

Body

application/json
​
user_emails
string<email>[]
required

A list of email addresses for the users to onboard.

Response

Onboarding results

​
users_in_onboarding_process
string[]

Email addresses of users that were successfully queued for onboarding.

​
users_unavailable_for_onboarding
string[]

Email addresses of users that could not be onboarded (for example, because they already have an account or no seats are available).

​
total_organization_seats
string

The total number of seats in your organization's subscription.

​
available_organization_seats
string

The number of remaining unassigned seats.