Portal Consumer Access

Connect Consumer Groups to Portals to control access to your marketplaces.

Portal Consumer Access object

Attributes

object

String

Type of the object, fixed as consumer access

id

String

The unique identifier of the consumer access

access

Object

Details about the access granted to the consumer

consumer_group

Object

created_at

Date

The ISO 8601 timestamp when the consumer access was created

updated_at

Date

The ISO 8601 timestamp when the consumer access was last updated

{
  "object": "consumer.group",
  "access": {
    "type": "server_deployment_template",
    "server_deployment_template": {
      "object": "server.server_deployment.template",
      "server": {
        "object": "server",
        "status": "active",
        "type": "public",
        "metadata": {},
        "variants": [
          {
            "object": "server.server_variant",
            "status": "active",
            "server": {
              "object": "server#preview",
              "type": "public"
            },
            "current_version": {
              "object": "server.server_version",
              "oauth": {
                "status": "disabled"
              },
              "source": {
                "type": "docker",
                "docker": {}
              },
              "schema": {},
              "created_at": "2024-01-15T09:30:00.000Z",
              "server": {
                "object": "server#preview",
                "type": "public"
              }
            },
            "source": {
              "type": "docker",
              "docker": {}
            }
          }
        ]
      }
    }
  },
  "consumer_group": {
    "object": "consumer.group",
    "status": "active"
  }
}

List Portal

Returns a paginated list of portals.

URL Parameters

portal_id

String

The unique identifier for the portal

Query Parameters

limit

NumberOptional

Maximum number of items to return (1-100)

after

StringOptional

Return items after this ID

before

StringOptional

Return items before this ID

cursor

StringOptional

Pagination cursor from a previous response

order

EnumOptional

Sort order for results

consumer_group_id

UnionOptional

Filter by consumer group ID(s)

server_deployment_template_id

UnionOptional

Filter by deployment template ID(s)

type

UnionOptional

Filter by access type

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

Get Consumer Access by ID

Retrieves details for a specific portal by its ID.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_access_id

String

The unique identifier for the consumer_access

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

Create Consumer Access

Creates a new sso tenant for the instance.

URL Parameters

portal_id

String

The unique identifier for the portal

Request Body

consumer_group_id

String

access

Object
POSThttp://api.metorial.com/portals/:portal_id/consumer-access
curl -X POST "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/consumer-access" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "consumer_group_id": "example_consumer_group_id",
  "access": {
    "type": "example_type",
    "server_deployment_template_id": "example_server_deployment_template_id"
  }
}'

Delete Portal

Deletes a portal from the instance.

URL Parameters

portal_id

String

The unique identifier for the portal

consumer_access_id

String

The unique identifier for the consumer_access

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