POST /self-signup – Handles user self-registration/signup process.


Headers:

  • Authorization: Bearer <access_token> (required)
  • Content-Type: application/json or application/x-www-form-urlencoded (required)

Body:

  • provider: The authentication provider (optional). Defaults to auth0-user.
  • Remaining properties of body depend on the provider SelfSignupRequest
  • clientId: The client ID associated with the user (required).
  • user:
    • email: The user's email address (required).
    • password: The user's password (required for Auth0).
    • Other fields optional as described in SelfSignupRequest
  • userPoolId: The Cognito user pool ID (required for Cognito).

Path Parameters:

  • None

Query Parameters:

  • None

  • 201 Created – Returns void.

Status Code Meaning When it Happens
400 Bad Request Missing or invalid fields in request body
401 Unauthorized Missing or invalid authentication token
409 Conflict Email address already exists
422 Unprocessable Entity Validation error (password requirements, invalid email format)
429 Too Many Requests Rate limit exceeded
500 Internal Server Error Unexpected error during MFA enrollment update
{
"error": "Detailed error message here"
}

POST /self-signup
{
"clientId": "auth0 clientId",(required)
"user": {
"email": "user@district.com",
"password": "SecurePassword123!"
}
}
POST /self-signup
{
"provider": "cognito-user",
"clientId": "cognito clientId",
"user": {
"email": "user@district.com"
},
"userPoolId": "us-east-1_1234test"
}
{}

  • Parameters

    • event: APIGatewayProxyEvent

      The API Gateway event containing the request.

    • context: Context
    • callback: Callback<APIGatewayProxyResult>

    Returns void | Promise<APIGatewayProxyResult>

    A Promise resolving to an API Gateway-compatible response.