Skip to main content

Get Direct-ID value for a person​

This endpoint creates a one-time Direct-ID for a specific user. The returned Direct-ID string can embedded in a URL in the challenges query parameter to let your users land on a target page already authenticated.

Path Parameters
  • person_id string required

    The person ID

    Example: 903c1ff9-f2cc-435c-b242-9d8a690fcf0a
Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Request Body required
  • duration_secs integer required

    How long (in seconds) the Direct-ID should be valid for. If unspecified, it is set to your organization's default value.

Responses

The result string is a Direct-ID you can include in your links in the challenges query parameter.

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • cursor_pagination object

    Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  • limit integer
  • next_cursor string

    Opaque token addressing the next page. Absent on the last page.

  • prev_cursor string

    Opaque token addressing the previous page. Absent on the first page.

  • last_cursor string

    Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  • total_count int64

    Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.

  • errors object[]
  • httpcode integer
  • message string
  • result string