---
title: "Get portal context"
url: "https://nov18-dev.movespot.fyi/apis/portal-2/versions/f312f74b-fa65-4573-b3a5-637b8a51ae20/operations/get-portal-context"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-2/versions/f312f74b-fa65-4573-b3a5-637b8a51ae20.md

# Get portal context

`GET` `/api/v2/portal`

Operation ID: `get-portal-context`

Return the portal context object.

## Responses

- `200` - portal context

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Portal
  version: 2.0.0
paths:
  /api/v2/portal:
    get:
      operationId: get-portal-context
      summary: Get portal context
      description: Return the portal context object.
      responses:
        "200":
          $ref: "#/components/responses/GetPortalContextResponse"
      security:
        - {}
      tags:
        - portal
security:
  - {}
components:
  responses:
    GetPortalContextResponse:
      description: portal context
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PortalContext"
  schemas:
    PortalContext:
      description: describe the portal execution context
      type: object
      properties:
        portal_id:
          type: string
          format: uuid
        org_id:
          type: string
          format: uuid
        featureset_id:
          type: string
        feature_set:
          description: String that determines feature set group developer belongs to when
            logged in
          type: string
        basic_auth_enabled:
          description: Whether the portal can be accessed via email and password
          type: boolean
        oidc_auth_enabled:
          description: Whether the portal can be accessed via authentication with Single
            Sign On (SSO) through OpenID Connect (OIDC) from a third-party
            Identity Provider
          type: boolean
        is_public:
          description: Whether the portal catalog can be accessed by non-authenticated users
          type: boolean
        rbac_enabled:
          description: Whether the portal is protected with Role-Based Access Control
          type: boolean
        dcr_provider_ids:
          description: The unique identifiers of each available client provider when using
            Dynamic Client Registration
          type: array
          items:
            type: string
            format: uuid
        allowed_time_period:
          description: Allowed time period for Analytics queries
          type: string
        name:
          description: Name of the developer portal.
          type: string
        canonical_domain:
          description: The canonical domain of the developer portal.
          type: string
      additionalProperties: false
      required:
        - canonical_domain
        - portal_id
        - org_id
        - is_public
        - featureset_id
        - basic_auth_enabled
        - oidc_auth_enabled
        - rbac_enabled
        - dcr_provider_ids
        - allowed_time_period
        - name
      title: Portal Context
```
