Activate System User

This endpoint changes the state of a STAGED user to ACTIVATED.

Email Flag

Use the "email" flag to determine whether or not to send a Welcome or Activation email to the newly activated user. Sending an empty body without the email flag, will send an email with default behavior (see the "Behavior" section below)

{}

Sending email=true flag will send an email with default behavior (see Behavior below)

{ "email": true }

Populated email will override the default behavior and send to the specified email value

{ "email": "example@example.com" }

Sending email=false will suppress sending the email

{ "email": false }

Behavior

Users with a password will be sent a Welcome email to:

• The address specified in email flag in the request
• If no email flag, the user's primary email address (default behavior) Users without a password will be sent an Activation email to:
• The address specified in email flag in the request
• If no email flag, the user's alternate email address (default behavior)
• If no alternate email address, the user's primary email address (default behavior)

Sample Request

curl -X POST https://console.jumpcloud.com/api/systemusers/{id}/state/activate \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: <api-key>' \
  -d '{ "email": "alternate-activation-email@email.com" }'