Portal Access Requests

Review and resolve access requests for a portal.

Portal Access Requests object

Attributes

object

String

id

String

status

Enum

message

StringNullable

resolution_message

StringNullable

consumer_profile

Object

target

Object

created_at

Date

updated_at

Date

reviewed_at

DateNullable
{
  "object": "consumer.access_request",
  "status": "pending",
  "consumer_profile": {
    "object": "consumer.profile#preview"
  },
  "target": {
    "type": "provider_template",
    "provider_template": {
      "object": "provider.template#preview",
      "status": "active",
      "metadata": {}
    }
  }
}

List portal access requests

Returns a paginated list of access requests for a portal.

URL Parameters

portal_id

String

The unique identifier for the portal

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

status

UnionOptional

consumer_profile_id

UnionOptional

search

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

Get portal access request

Retrieves a access request by ID.

URL Parameters

portal_id

String

The unique identifier for the portal

access_request_id

String

The unique identifier for the access_request

GEThttp://api.metorial.com/portals/:portal_id/access-requests/:access_request_id
curl -X GET "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/access-requests/acc_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Review portal access request

Approves or rejects a access request.

URL Parameters

portal_id

String

The unique identifier for the portal

access_request_id

String

The unique identifier for the access_request

Request Body

status

Enum

resolution_message

StringOptional

consumer_group_id

StringOptional
PATCHhttp://api.metorial.com/portals/:portal_id/access-requests/:access_request_id
curl -X PATCH "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/access-requests/acc_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "status": "approved",
  "resolution_message": "example_resolution_message",
  "consumer_group_id": "example_consumer_group_id"
}'