ANanthropics

Create Enrollment URL

Changed on
post/v1/user_profiles/{user_profile_id}/enrollment_url?beta=true

Request

  • Base URL
    https://api.anthropic.com
  • Auth
    none declared

Path parameters

user_profile_idstring required

The ID of the user profile to create an enrollment URL for (uprof_...).

Headers

anthropic-versionstring

The version of the Claude API you want to use.

Read more about versioning and our version history here.

anthropic-workspace-idstring

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Response

Successful response (OK)

urlstring required

Enrollment URL to send to the end user. Valid until expires_at.

expires_atstring date-time required

A timestamp in RFC 3339 format

type'enrollment_url' required

Object type. Always enrollment_url.

Example response

{
  "type": "enrollment_url",
  "url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1",
  "expires_at": "2026-03-15T10:15:00Z"
}

Changes

  • 037a593978dcRevision changes
    • info

      added the enum value admin-user-sign-out-2026-10-08 to the property items/anyOf[subschema #2]/ of the header request parameter anthropic-beta

  • f538a797852cRevision changes
    • info

      added the enum value experimental-claude-tag-2026-10-21 to the property items/anyOf[subschema #2]/ of the header request parameter anthropic-beta