Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Authentication

Get Consumer App Portal Access

Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.

post/api/v1/auth/app-portal-access/{app_id}

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

Headers

idempotency-keystring

The request's idempotency key

Request body

readOnlyboolean nullable

Whether the app portal should be in read-only mode.

capabilitiesAppPortalCapability[] nullable

Custom capabilities attached to the token, You can combine as many capabilities as necessary.

The ViewBase capability is always required

  • ViewBase: Basic read only permissions, does not allow the user to see the endpoint secret.

  • ViewEndpointSecret: Allows user to view the endpoint secret.

  • ManageEndpointSecret: Allows user to rotate and view the endpoint secret.

  • ManageTransformations: Allows user to modify the endpoint transformations.

  • CreateAttempts: Allows user to replay missing messages and send example messages.

  • ManageEndpoint: Allows user to read/modify any field or configuration of an endpoint (including secrets)

By default, the token will get all capabilities if the capabilities are not explicitly specified.

featureFlagsstring[]

The set of feature flags the created token will have access to.

expiryinteger nullable

How long the token will be valid for, in seconds.

Valid values are between 1 hour and 7 days. The default is 7 days.

sessionIdstring nullable

An optional session ID to attach to the token.

When expiring tokens with "Expire All", you can include the session ID to only expire tokens that were created with that session ID.

Example request

{
  "application": {
    "name": "My first application",
    "uid": "unique-identifier"
  },
  "capabilities": [
    "ViewBase",
    "ViewEndpointSecret"
  ],
  "featureFlags": [],
  "sessionId": "user_1FB8"
}

Response

urlstring uri required
tokenstring required

Example response

{
  "url": "https://app.svix.com/login#key=eyJhcHBJZCI6ICJhcHBfMXRSdFl",
  "token": "appsk_kV3ts5tKPNJN4Dl25cMTfUNdmabxbX0O"
}
All 244 operations