Directory Users

Activates a directory user.

  • userId is required. It must be the UserGUID value from the directory table that uniquely identifies the user.
  • sendEmail is optional (default: true).
    • true - the built-in activation email (using your directory's template) is sent to the user.
    • false - no email is sent and the returned ActivationUrl must be used to build and send a custom activation email.
post/v4/directories/{directoryId}/users/{userId}/activate

Request

  • Base URL: https://demo.caspio.com/integrations/rest
  • URL: https://demo.caspio.com/integrations/rest/v4/directories/{directoryId}/users/{userId}/activate
  • Auth: API key in header Authorization

Path parameters

directoryIdstring required

The directory identifier (6-character alphanumeric code).

userIdstring required

The user's UserGUID value.

Query parameters

sendEmailboolean

When true (default), sends the built-in activation email to the user. When false, returns an activation URL instead.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.