Update Settings - Authentication

User Guide > Resources > Update Authentication Settings

This request changes authentication settings attributes.

Resource

PATCH /server/authentication

Parameters

None

Payload

Patch Document

Fields

Name Patch Operations

code

replace

securityDomain

replace

domainServer1

replace

domainServer2

replace

synchronizeDomainTime

replace

openIdConnections

add, remove

tokenRetentionDays

replace

minimumPasswordLength

replace

maxNumberOfFalseLogins

replace

OpenID connection

openIdConnection.openIdId

replace

openIdConnection.openIdProvider

replace

openIdConnection.liveSyncOn

replace

openIdConnection.openIdGroupId

replace

Response

None

Context

Authorization

Administrator

Errors

Common Errors

Example

Request
PATCH https://xelion.nl/api/v1/master/server/authentication
Payload

replace some authorization settings direct members

{
        "operations": [{
                        "op": "replace",
                        "path": "/securityDomain",
                        "value": "mySecurityDomain"
                }, {
                        "op": "replace",
                        "path": "/domainServer1",
                        "value": "myDomainServer1"
                }, {
                        "op": "replace",
                        "path": "/domainServer2",
                        "value": "myDomainServer2"
                }, {
                        "op": "replace",
                        "path": "/synchronizeDomainTime",
                        "value": true
                }
        ]
}

add a new OpenId connection to the authentication settings, first add a path with a virtual id '1' and insert the oid of the OpenId connection as value

{
        "operations": [{
                        "op": "add",
                        "path": "/openIdConnections/1",
                        "value": "1756113"
                }
        ]
}

remove an OpenId connection from the authentication settings, <OID> is the oid of the OpenIdConnection object

{
        "operations": [{
                        "op": "remove",
                        "path": "/openIdConnections/321443"
                }
        ]
}

patch an existing OpenId connection from the authentication settings, <OID> is the oid of the OpenIdConnection object

{
   "operations":[
      {
         "op":"replace",
         "path":"/openIdConnections/3669834/openIdId",
         "value":"myOpenIdId"
      },
      {
         "op":"replace",
         "path":"/openIdConnections/3669834/openIdProvider",
         "value":"MICROSOFT"
      },
      {
         "op":"replace",
         "path":"/openIdConnections/3669834/openIdGroupId",
         "value":"myopenIdGroupId"
      },
      {
         "op":"replace",
         "path":"/openIdConnections/3669834/liveSyncOn",
         "value":true
      }
   ]
}