> ## 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. # Get Or Register Access Gateway Info > Returns accessgateway registration info and registers a new or adds the url if necessary NsApiSlow threshold: 1000 ms. ## 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/GetOrRegisterAccessGatewayInfo 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/GetOrRegisterAccessGatewayInfo: post: tags: - User_Agent summary: Get Or Register Access Gateway Info description: "Returns accessgateway registration info and registers a new or adds the url if necessary\n\nNsApiSlow threshold: 1000 ms.\r\n## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps." operationId: v1UserAgent_GetOrRegisterAccessGatewayInfo 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.GetOrRegisterAccessGatewayInfoRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.GetOrRegisterAccessGatewayInfoRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.GetOrRegisterAccessGatewayInfoRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.GetOrRegisterAccessGatewayInfoRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.GetOrRegisterAccessGatewayInfoRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.GetOrRegisterAccessGatewayInfoRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.GetOrRegisterAccessGatewayInfoRequest description: RedirectUri required: true responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AccessGatewayInfo text/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AccessGatewayInfo application/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AccessGatewayInfo text/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AccessGatewayInfo application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AccessGatewayInfo application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AccessGatewayInfo security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.UserCarriers.GetOrRegisterAccessGatewayInfoRequest: description: >- GetOrRegisterAccessGatewayInfo: Returns accessgateway registration info and registers a new or adds the url if necessary type: object properties: RedirectUri: type: string SuperOffice.CRM.Services.AccessGatewayInfo: description: "Access gateway related data and operations\r\n\r\nCarrier object for AccessGatewayInfo.\r\nServices for the AccessGatewayInfo Carrier is available from the User Agent." type: object properties: ClientId: description: This is the registered client_id for AccessGateway OIDC type: string RedirectUri: description: This is the registered redirect_uri for AccessGateway OIDC. 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 - [SuperOffice.WebApi.Data.User GetOrRegisterAccessGatewayInfoRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.User_GetOrRegisterAccessGatewayInfoRequest.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) - [Register With Access Gateway](/en/api/reference/restful/agent/user_agent/register-with-access-gateway.md) - [NSAccessGatewayInfo](/en/automation/crmscript/reference/CRMScript.NetServer.NSAccessGatewayInfo.md) - [Get Access Gateway Info](/en/api/reference/restful/agent/user_agent/get-access-gateway-info.md)