Portal Auth

Connect various authentication factors to your portal instance.

Portal Auth object

Attributes

object

String

Type of the object, fixed as consumer auth factor

id

String

The unique identifier for the consumer auth factor

type

Enum

The type of consumer auth factor

status

Enum

The status of the consumer auth factor

name

String

The internal name of the consumer auth factor

publicName

String

The public name of the consumer auth factor

created_at

Date

The ISO 8601 timestamp when the consumer auth factor was created

updated_at

Date

The ISO 8601 timestamp when the consumer auth factor was last updated

{
  "object": "consumer.auth_factor",
  "type": "email_code",
  "status": "active"
}

List Portal

Returns a paginated list of portals.

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-factors
curl -X GET "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/auth-factors" \
  -H "Authorization: Bearer metorial_sk_..."

Get Auth by ID

Retrieves details for a specific portal by its ID.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_auth_factor_id

String

The unique identifier for the consumer_auth_factor

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

Create Auth

Creates a new sso tenant for the instance.

URL Parameters

portal_id

String

The unique identifier for the portal

Request Body

type

String

type

String

sso_tenant_id

String
POSThttp://api.metorial.com/portals/:portal_id/auth-factors
curl -X POST "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/auth-factors" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "type": "example_type",
  "sso_tenant_id": "example_sso_tenant_id"
}'

Delete Portal

Deletes a portal from the instance.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_auth_factor_id

String

The unique identifier for the consumer_auth_factor

DELETEhttp://api.metorial.com/portals/:portal_id/auth-factors/:consumer_auth_factor_id
curl -X DELETE "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/auth-factors/con_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Update Portal

Updates a portal from the instance.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_auth_factor_id

String

The unique identifier for the consumer_auth_factor

Request Body

name

StringOptional

public_name

StringOptional
PATCHhttp://api.metorial.com/portals/:portal_id/auth-factors/:consumer_auth_factor_id
curl -X PATCH "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/auth-factors/con_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "public_name": "example_public_name"
}'