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

# Save External Tokens

> Saves the external tokens to the DB and returns a key that can be used to retrieve them

NsApiSlow threshold: 1000 ms.
<para />## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps.



## OpenAPI

````yaml /openapi/agent/openapi-v3-UserAgent.json post /api/v1/Agents/User/SaveExternalTokens
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - UserAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/User/SaveExternalTokens:
    post:
      tags:
        - User_Agent
      summary: Save External Tokens
      description: "Saves the external tokens to the DB and returns a key that can be used to retrieve them\n\nNsApiSlow threshold: 1000 ms.\r\n<para />## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps."
      operationId: v1UserAgent_SaveExternalTokens
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SaveExternalTokensRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SaveExternalTokensRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SaveExternalTokensRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SaveExternalTokensRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SaveExternalTokensRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SaveExternalTokensRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SaveExternalTokensRequest
        description: TokenManagementInfo
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
            text/xml:
              schema:
                type: string
            application/json-patch+json:
              schema:
                type: string
            application/merge-patch+json:
              schema:
                type: string
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.UserCarriers.SaveExternalTokensRequest:
      description: >-
        SaveExternalTokens: Saves the external tokens to the DB and returns a
        key that can be used to retrieve them
      type: object
      properties:
        TokenManagementInfo:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.TokenManagementInfo'
    SuperOffice.CRM.Services.TokenManagementInfo:
      description: "Token information\r\n<para />\r\nCarrier object for TokenManagementInfo.\r\nServices for the TokenManagementInfo Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IUserAgent\">User Agent</see>."
      type: object
      properties:
        Provider:
          description: The provider the access and refresh token belong to.
          type: string
        AccessToken:
          description: Access token (Provider)
          type: string
        RefreshToken:
          description: Refresh token (Provider)
          type: string
        Claims:
          description: JSON serialized dictionary of claims from the AG id_token
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [Decrypt And Save External Tokens](/en/api/reference/restful/agent/user_agent/decrypt-and-save-external-tokens.md)
- [SuperOffice.WebApi.Data.User SaveExternalTokensRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.User_SaveExternalTokensRequest.md)
- [SuperOffice.WebApi.Data.User DecryptAndSaveExternalTokensRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.User_DecryptAndSaveExternalTokensRequest.md)
- [NSUserAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSUserAgent.md)
- [SuperOffice.WebApi.Agents.UserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.UserAgent.md)
- [SuperOffice.WebApi.Agents.IUserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IUserAgent.md)
