Portal Access

Manage which consumer groups can access portal provider templates and MCP servers.

Portal Access object

Attributes

object

Enumconsumer.access

id

String

access_level

EnumNullable

name

String

description

StringNullable

readme

StringNullable

listing

ObjectNullable

access

Union

consumer_group

Object

created_at

Date

updated_at

Date
{
  "object": "consumer.access",
  "access_level": "read",
  "listing": {},
  "access": {
    "type": "provider_template",
    "provider_template": {
      "object": "provider.template#preview",
      "status": "active",
      "metadata": {}
    }
  },
  "consumer_group": {
    "object": "consumer.group",
    "status": "active"
  }
}

List portal access

Returns a paginated list of consumer access rules 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

search

StringOptional

consumer_group_id

UnionOptional

provider_template_id

UnionOptional

magic_mcp_server_id

UnionOptional

skill_id

UnionOptional

skill_template_id

UnionOptional

skill_group_id

UnionOptional

skill_marketplace_id

UnionOptional

skill_plugin_id

UnionOptional

consumer_access_listing_id

UnionOptional

type

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

Get portal access

Retrieves a portal access rule by ID.

URL Parameters

portal_id

String

The unique identifier for the portal

access_id

String

The unique identifier for the access

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

Create portal access

Creates a new consumer access rule for the portal.

URL Parameters

portal_id

String

The unique identifier for the portal

Request Body

consumer_group_id

String

name

StringOptional

description

StringOptionalNullable

readme

StringOptionalNullable

access

Union
POSThttps://api.metorial.com/portals/:portal_id/access
curl -X POST "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/access" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "consumer_group_id": "example_consumer_group_id",
  "name": "example_name",
  "description": "example_description",
  "readme": "example_readme",
  "access": {
    "type": "provider_template",
    "provider_template_id": "example_provider_template_id"
  }
}'

Update portal access

Updates the shared listing fields for a portal access rule.

URL Parameters

portal_id

String

The unique identifier for the portal

access_id

String

The unique identifier for the access

Request Body

name

StringOptional

description

StringOptionalNullable

readme

StringOptionalNullable
PATCHhttps://api.metorial.com/portals/:portal_id/access/:access_id
curl -X PATCH "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/access/acc_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "readme": "example_readme"
}'

Delete portal access

Deletes a consumer access rule from the portal.

URL Parameters

portal_id

String

The unique identifier for the portal

access_id

String

The unique identifier for the access

DELETEhttps://api.metorial.com/portals/:portal_id/access/:access_id
curl -X DELETE "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/access/acc_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."