> ## Documentation Index
> Fetch the complete documentation index at: https://docs.togai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get delegate token for customer portal

> Get delegate token for customer portal



## OpenAPI

````yaml post /portal/token
openapi: 3.0.3
info:
  version: '1.0'
  title: Togai Apis
  contact:
    email: engg@togai.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  description: APIs for Togai App
servers:
  - description: Api endpoint
    url: https://api.togai.com/
  - description: Sandbox api endpoint
    url: https://sandbox-api.togai.com/
security:
  - bearerAuth: []
tags:
  - name: Customers
    description: Customer level calls
  - name: Accounts
    description: Account level calls
  - name: Event Schemas
    description: Event Schema level calls
  - name: Usage Meters
    description: Usage Meter level calls
  - name: Price Plans
    description: (DEPRECATED) Price Plan level calls
  - name: PricePlanV2
    description: Price Plan V2 level calls
  - name: Schedules
    description: Account Schedule level calls
  - name: Pricing Rules
    description: Pricing Rules level calls
  - name: Settings
    description: Settings
  - name: Price Experimentation
    description: Price Experimentation apis
  - name: InvoiceGroups
    description: Invoice Group level calls
  - name: Organization
    description: Organization level calls
  - name: FileStorage
    description: File Storage level calls
  - name: Aliases
    description: Alias level calls
  - name: Reports
    description: Report level calls
  - name: ReportTemplates
    description: Report Template level calls
  - name: Customer Portal
    description: Portal level calls
  - name: Alerts
    description: Alert level calls
  - name: Event Management
    description: APIs for getting events ingested in Togai
    externalDocs:
      description: docs
      url: https://togai.com/docs/billing/events
  - name: Metrics
    description: APIs for getting Togai metrics
    externalDocs:
      description: docs
      url: https://togai.com/docs/metrics
  - name: Licenses
    description: APIs for getting or updating license records in Togai
  - name: Entitlements
    description: APIs related to entitlements
  - name: Invoices
    description: Invoices API
  - name: Credits
    description: Credits API
  - name: Wallet
    description: Wallet API
  - name: InvoiceTemplates
    description: InvoiceTemplates API
  - name: InvoiceSequence
    description: InvoiceSequence API
  - name: Payments
    description: Payments API
  - name: Authentication
    description: Authentication API
externalDocs:
  description: Find out more about Togai
  url: https://docs.togai.com/docs
paths:
  /portal/token:
    post:
      tags:
        - Customer Portal
      summary: Get delegate token for customer portal
      description: Get delegate token for customer portal
      operationId: getCustomerPortalDelegateToken
      requestBody:
        $ref: '#/components/requestBodies/GetCustomerPortalDelegateTokenRequest'
      responses:
        '200':
          $ref: '#/components/responses/TokenResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
        '401':
          $ref: '#/components/responses/ErrorResponse'
        '403':
          $ref: '#/components/responses/ErrorResponse'
        '404':
          $ref: '#/components/responses/ErrorResponse'
        '429':
          $ref: '#/components/responses/ErrorResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  requestBodies:
    GetCustomerPortalDelegateTokenRequest:
      description: Payload to get delegate token for customer portal
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GetCustomerPortalDelegateTokenRequest'
          examples:
            GetCustomerPortalDelegateTokenRequestAllAccountsAccess:
              $ref: >-
                #/components/examples/GetCustomerPortalDelegateTokenRequestAllAccountsAccess
            GetCustomerPortalDelegateTokenRequestSelectedAccountsAccess:
              $ref: >-
                #/components/examples/GetCustomerPortalDelegateTokenRequestSelectedAccountsAccess
  responses:
    TokenResponse:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TokenResponse'
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            ErrorResponse:
              summary: Error message
              value:
                message: <Reason message>
  schemas:
    GetCustomerPortalDelegateTokenRequest:
      description: Request to get delegate token for customer portal
      type: object
      additionalProperties: false
      required:
        - customerId
      properties:
        customerId:
          description: Identifier of the customer
          type: string
        accountIds:
          description: >
            Identifier of the accounts under the customer for which access is
            requested. Maximum of 5 account ids can be provided
          type: array
          items:
            type: string
        allAccountsAccess:
          description: >-
            Flag to specify if access for every account under the customer is
            required
          type: boolean
        expiry:
          description: >
            Expiry in seconds from the time of generation. 

            If not provided, generated token will have the expiry of the token
            used for requesting.
          type: integer
          format: int64
    TokenResponse:
      type: object
      additionalProperties: false
      required:
        - token
      properties:
        token:
          type: string
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - message
      properties:
        message:
          type: string
          description: error description
          maxLength: 500
  examples:
    GetCustomerPortalDelegateTokenRequestAllAccountsAccess:
      value:
        customerId: acme_cust
        allAccountsAccess: true
        expiry: 60000
    GetCustomerPortalDelegateTokenRequestSelectedAccountsAccess:
      value:
        customerId: acme_cust
        accountIds:
          - acme_accnt_1
          - acme_accnt_2
        expiry: 60000
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Bearer <credential>

````