> ## 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 Service Auth

> Updates the existing ServiceAuth or creates a new ServiceAuth if the id parameter is 0.

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/SaveServiceAuth
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/SaveServiceAuth:
    post:
      tags:
        - User_Agent
      summary: Save Service Auth
      description: "Updates the existing ServiceAuth or creates a new ServiceAuth if the id parameter is 0.\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_SaveServiceAuth
      parameters:
        - 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.CRM.Services.ServiceAuth'
          text/json:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.ServiceAuth'
          application/xml:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.ServiceAuth'
          text/xml:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.ServiceAuth'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.ServiceAuth'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.ServiceAuth'
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.ServiceAuth'
        description: The ServiceAuth that is saved
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ServiceAuth'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ServiceAuth'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ServiceAuth'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ServiceAuth'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ServiceAuth'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ServiceAuth'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.ServiceAuth:
      description: "Properties for service authentication\r\n<para />\r\nCarrier object for ServiceAuth.\r\nServices for the ServiceAuth Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IUserAgent\">User Agent</see>."
      type: object
      properties:
        ServiceAuthId:
          format: int32
          description: The primary key
          type: integer
        Server:
          description: The mail server
          type: string
        Port:
          format: int32
          description: The server port
          type: integer
        AuthType:
          description: The type of authentication, plain-text, OAuth...
          type: string
        Username:
          description: The username
          type: string
        Password:
          description: The (decrypted) password or 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

- [NSUserAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSUserAgent.md)
- [SuperOffice.WebApi.Agents.IUserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IUserAgent.md)
- [SuperOffice.WebApi.Agents.UserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.UserAgent.md)
- [NSServiceAuth](/en/automation/crmscript/reference/CRMScript.NetServer.NSServiceAuth.md)
- [Delete Service Auth](/en/api/reference/restful/agent/user_agent/delete-service-auth.md)
- [service_auth table](/en/database/tables/service-auth.md)