Portal Auth

Manage the Ares-backed authentication configuration for a portal.

Portal Auth object

Attributes

object

String

id

String

The Ares app identifier for this portal.

slug

StringNullable

The Ares app slug.

email_whitelist

Array of Strings

created_at

Date

updated_at

Date
{
  "object": "portal.auth.app",
  "id": "example_id",
  "slug": "example_slug",
  "email_whitelist": [
    "example_item"
  ],
  "created_at": "2026-05-22T18:43:37.154Z",
  "updated_at": "2026-05-22T18:43:37.154Z"
}

Get portal auth app

Returns the Ares app configuration for a portal.

URL Parameters

portal_id

String

The unique identifier for the portal

GEThttp://api.metorial.com/portals/:portal_id/auth/app
curl -X GET "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/auth/app" \
  -H "Authorization: Bearer metorial_sk_..."

Update portal auth app

Updates the portal auth app configuration stored on the portal surface.

URL Parameters

portal_id

String

The unique identifier for the portal

Request Body

email_whitelist

Array of StringsOptional
PATCHhttp://api.metorial.com/portals/:portal_id/auth/app
curl -X PATCH "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/auth/app" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "email_whitelist": [
    "example_item"
  ]
}'

List portal auth SSO tenants

Returns the SSO tenants configured for a portal Ares app.

URL Parameters

portal_id

String

The unique identifier for the portal

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional
GEThttp://api.metorial.com/portals/:portal_id/auth/sso-tenants
curl -X GET "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/auth/sso-tenants" \
  -H "Authorization: Bearer metorial_sk_..."

Create portal auth SSO tenant

Creates an SSO tenant for the portal Ares app.

URL Parameters

portal_id

String

The unique identifier for the portal

Request Body

name

String
POSThttp://api.metorial.com/portals/:portal_id/auth/sso-tenants
curl -X POST "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/auth/sso-tenants" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name"
}'

Create portal auth SSO tenant setup

Creates an Ares setup URL for finishing portal SSO tenant configuration.

URL Parameters

portal_id

String

The unique identifier for the portal

sso_tenant_id

String

The unique identifier for the sso_tenant

POSThttp://api.metorial.com/portals/:portal_id/auth/sso-tenants/:sso_tenant_id/setup
curl -X POST "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/auth/sso-tenants/sso_Rm4Mnheq2bfEPhBhP7SY/setup" \
  -H "Authorization: Bearer metorial_sk_..."

List portal auth SSO tenant connections

Returns SSO connections that belong to a portal SSO tenant.

URL Parameters

portal_id

String

The unique identifier for the portal

sso_tenant_id

String

The unique identifier for the sso_tenant

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional
GEThttp://api.metorial.com/portals/:portal_id/auth/sso-tenants/:sso_tenant_id/connections
curl -X GET "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/auth/sso-tenants/sso_Rm4Mnheq2bfEPhBhP7SY/connections" \
  -H "Authorization: Bearer metorial_sk_..."