Portal Consumer Profiles

Manage the consumers and effective group assignments for a portal.

Portal Consumer Profiles object

Attributes

object

Enumconsumer.profile

id

String

name

String

email

String

image_url

String

consumer_id

String

status

Enum

created_at

Date

updated_at

Date

groups

Array of ObjectsNullable
{
  "object": "consumer.profile",
  "id": "example_id",
  "name": "example_name",
  "email": "example_email",
  "image_url": "example_image_url",
  "consumer_id": "example_consumer_id",
  "status": "active",
  "created_at": "2026-07-21T07:34:10.615Z",
  "updated_at": "2026-07-21T07:34:10.615Z",
  "groups": [
    {
      "object": "consumer.profile.group_assignment",
      "group": {
        "object": "consumer.group",
        "id": "example_id",
        "status": "active",
        "name": "example_name",
        "description": "example_description",
        "is_default": false,
        "sso_group_ids": [
          "example_sso_group_ids"
        ],
        "created_at": "2026-07-21T07:34:10.615Z",
        "updated_at": "2026-07-21T07:34:10.615Z"
      },
      "assigned_via": "default"
    }
  ]
}

List portal consumer profiles

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

email

UnionOptional

consumer_group_id

StringOptional

status

UnionOptional
GEThttps://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 profile

Retrieves a portal consumer profile by ID.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_profile_id

String

The unique identifier for the consumer_profile

GEThttps://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 profile

Creates a new portal consumer profile.

URL Parameters

portal_id

String

The unique identifier for the portal

Request Body

email

String

name

String
POSThttps://api.metorial.com/portals/:portal_id/consumer-profile
curl -X POST "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/consumer-profile" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "email": "example_email",
  "name": "example_name"
}'

Delete portal consumer profile

Soft-deletes a portal consumer profile.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_profile_id

String

The unique identifier for the consumer_profile

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

Assign portal consumer profile groups

Assigns one or more groups to a portal consumer profile.

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
POSThttps://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_group_ids"
  ]
}'

Unassign portal consumer profile groups

Removes one or more groups from a portal consumer profile.

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
POSThttps://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_group_ids"
  ]
}'