Portal Consumer Groups

Connect Magic MCP Groups to Portals to control access to your marketplaces.

Portal Consumer Groups object

Attributes

object

String

Type of the object, fixed as consumer.profile

id

String

The unique identifier of the consumer profile

name

String

The name of the consumer profile

email

String

The email address of the consumer profile

image_url

String

The URL of the profile image associated with this consumer profile

groups

ObjectNullable

A list of groups that the consumer profile is associated with, along with assignment method

consumer_id

String

The unique identifier of the consumer associated with this profile

created_at

Date

The ISO 8601 timestamp when the consumer profile was created

updated_at

Date

The ISO 8601 timestamp when the consumer profile was last updated

{
  "object": "consumer.profile",
  "groups": [
    {
      "object": "consumer.profile.group_assignment",
      "group": {
        "object": "consumer.group",
        "status": "active"
      },
      "assigned_via": "default"
    },
    {
      "object": "consumer.profile.group_assignment",
      "group": {
        "object": "consumer.group",
        "status": "active"
      },
      "assigned_via": "default"
    }
  ]
}

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

Get Portal Consumer Group by ID

Retrieves details for a specific portal by its ID.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_profile_id

String

The unique identifier for the consumer_profile

GEThttp://api.metorial.com/portals/:portal_id/consumer-profile/:consumer_profile_id
curl -X GET "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/consumer-profile/con_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create Portal Consumer Group

Creates a new sso tenant for the instance.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_profile_id

String

The unique identifier for the consumer_profile

Request Body

group_ids

Array of Strings
POSThttp://api.metorial.com/portals/:portal_id/consumer-profile/:consumer_profile_id/assign-groups
curl -X POST "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/consumer-profile/con_Rm4Mnheq2bfEPhBhP7SY/assign-groups" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "group_ids": [
    "example_item"
  ]
}'

Remove Portal Consumer Profile from Group

Removes a consumer profile from a consumer group.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_profile_id

String

The unique identifier for the consumer_profile

Request Body

group_ids

Array of Strings
POSThttp://api.metorial.com/portals/:portal_id/consumer-profile/:consumer_profile_id/unassign-groups
curl -X POST "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/consumer-profile/con_Rm4Mnheq2bfEPhBhP7SY/unassign-groups" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "group_ids": [
    "example_item"
  ]
}'