TRtrycourier
Authentication

Create a JWT

Changed on

Returns a JWT for authenticating client-side SDKs such as the Inbox. You supply the scope and an expires_in duration, both required.

post/auth/issue-token

Request

Request body

scopestring required

Available scopes:

  • user_id:<user-id> - Defines which user the token will be scoped to. Multiple can be listed if needed. Ex user_id:pigeon user_id:bluebird.
  • read:messages - Read messages.
  • read:user-tokens - Read user push tokens.
  • write:user-tokens - Write user push tokens.
  • read:brands[:<brand_id>] - Read brands, optionally restricted to a specific brand_id. Examples read:brands, read:brands:my_brand.
  • write:brands[:<brand_id>] - Write brands, optionally restricted to a specific brand_id. Examples write:brands, write:brands:my_brand.
  • inbox:read:messages - Read inbox messages.
  • inbox:write:events - Write inbox events, such as mark message as read.
  • read:preferences - Read user preferences.
  • write:preferences - Write user preferences. Example: user_id:user123 write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands
expires_instring required

Duration for token expiration. Accepts various time formats:

  • "2 hours" - 2 hours from now
  • "1d" - 1 day
  • "3 days" - 3 days
  • "10h" - 10 hours
  • "2.5 hrs" - 2.5 hours
  • "1m" - 1 minute
  • "5s" - 5 seconds
  • "1y" - 1 year

Response

tokenstring required

Changes

  • e67d02739533Revision changes
    • info

      api tag Authentication added

    • info

      api tag AuthTokens removed

  • 7143ea51f307Revision changes
    • breaking

      removed the enum value inbox:read:messages of the request property

    • breaking

      removed the enum value inbox:write:event of the request property

    • breaking

      removed the enum value inbox:write:events of the request property

    • breaking

      removed the enum value inbox:write:messages of the request property

    • breaking

      removed the enum value read:brands of the request property

    • breaking

      removed the enum value read:brands{:id} of the request property

    • breaking

      removed the enum value read:preferences of the request property

    • breaking

      removed the enum value read:user-tokens of the request property

    • breaking

      removed the enum value user_id:$YOUR_USER_ID of the request property

    • breaking

      removed the enum value write:brands of the request property

    • breaking

      removed the enum value write:brands{:id} of the request property

    • breaking

      removed the enum value write:preferences of the request property

    • breaking

      removed the enum value write:track of the request property

    • breaking

      removed the enum value write:user-tokens of the request property

    • info

      the response property became required for the status