Portal Consumer Groups

Manage the consumer groups that drive portal visibility and access rules.

Portal Consumer Groups object

Attributes

object

String

id

String

status

Enum

name

String

description

StringNullable

is_default

Boolean

sso_group_ids

Array of Strings

created_at

Date

updated_at

Date
{
  "object": "consumer.group",
  "status": "active"
}

List portal consumer groups

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

search

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

Get portal consumer group

Retrieves a portal consumer group by ID.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_group_id

String

The unique identifier for the consumer_group

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

Create portal consumer group

Creates a new consumer group for the portal.

URL Parameters

portal_id

String

The unique identifier for the portal

Request Body

name

String

description

StringOptional

sso_group_ids

Array of StringsOptional

is_default

BooleanOptional
POSThttp://api.metorial.com/portals/:portal_id/consumer-groups
curl -X POST "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/consumer-groups" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "sso_group_ids": [
    "example_item"
  ],
  "is_default": false
}'

Update portal consumer group

Updates a consumer group for the portal.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_group_id

String

The unique identifier for the consumer_group

Request Body

name

StringOptional

description

StringOptional

sso_group_ids

Array of StringsOptional

is_default

BooleanOptional
PATCHhttp://api.metorial.com/portals/:portal_id/consumer-groups/:consumer_group_id
curl -X PATCH "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/consumer-groups/con_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "sso_group_ids": [
    "example_item"
  ],
  "is_default": false
}'

Delete portal consumer group

Archives a consumer group for the portal.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_group_id

String

The unique identifier for the consumer_group

DELETEhttp://api.metorial.com/portals/:portal_id/consumer-groups/:consumer_group_id
curl -X DELETE "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/consumer-groups/con_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."