---
title: "Get Portal Context"
url: "https://nov18-dev.movespot.fyi/apis/portal-2/versions/891fea74-0458-4c01-8657-e3e36ffacc99/operations/get-portal-context"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-2/versions/891fea74-0458-4c01-8657-e3e36ffacc99.md

# Get Portal Context

`GET` `/api/v3/portal`

Operation ID: `get-portal-context`

Returns information about the portal.

## Responses

- `200` - The portal context object

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Portal
  version: 3.3.1
paths:
  /api/v3/portal:
    get:
      operationId: get-portal-context
      summary: Get Portal Context
      description: Returns information about the portal.
      responses:
        "200":
          $ref: "#/components/responses/GetPortalContextResponse"
      security:
        - portalAccessToken: []
        - {}
      tags:
        - Portal
security:
  - portalAccessToken: []
  - {}
components:
  responses:
    GetPortalContextResponse:
      description: The portal context object
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PortalContext"
          examples:
            GetPortalContextResponseExample1:
              value:
                portal_id: 18a9b697-7e68-411b-8e1d-102b261ab18e
                org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
                basic_auth_enabled: true
                oidc_auth_enabled: true
                saml_auth_enabled: true
                authentication_enabled: true
                rbac_enabled: true
                name: my portal
                canonical_domain: portal.example.com
  schemas:
    PortalContext:
      description: Describes the portal execution context
      type: object
      properties:
        portal_id:
          description: ID of the portal
          type: string
          format: uuid
        org_id:
          description: ID of the organization
          type: string
          format: uuid
        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
        saml_auth_enabled:
          description: Whether the portal can be accessed via SAML authentication
          type: boolean
        authentication_enabled:
          description: Whether authentication is enabled for the portal
          type: boolean
        rbac_enabled:
          description: Whether Role-Based Access Control is enabled for the portal
          type: boolean
        name:
          description: Name of the developer portal
          type: string
        canonical_domain:
          description: The canonical domain of the developer portal
          type: string
      additionalProperties: false
      required:
        - portal_id
        - org_id
        - basic_auth_enabled
        - oidc_auth_enabled
        - saml_auth_enabled
        - authentication_enabled
        - rbac_enabled
        - name
        - canonical_domain
      title: PortalContext
  securitySchemes:
    portalAccessToken:
      type: apiKey
      in: cookie
      name: portalaccesstoken
      description: >
        The Developer portal cookie is meant to be used by the Developer API to
        authenticate with.
```
