Product Documentation

Following request body is sent during the configuration web service call with update operation:

  • URL: https://<FQDN>:<PORT>/skfs/rest/configuration

  • HTTP Method: POST

  • FIDO2_0 request body:
    {
      "svcinfo": {
        "did": 1,
        "protocol": "FIDO2_0",
        "authtype": "PASSWORD",
        "svcusername": "fidoadminuser",
        "svcpassword": "Abcd1234!"
      },
      "operation": "update",
      "payload": {
         "configurations" : [{
      		"configkey": "skfs.cfg.property.allow.changeusername",
      		"configvalue": "true",
      		"notes" : "Allowing for the SKFS change Username"
      	}]
      }
    }
    

 

svcinfo Description

Value

Explanation

did

Unique identifier for a cryptographic domain in SKFS. Unless you are using a StrongKey Tellaro appliance, this defaults to 1.

protocol

The FIDO protocol to be used in this request (FIDO2_0).

authtype

The type of authentication supplied in this service request—it must be PASSWORD or HMAC (see API Security for details); the example shown here is for PASSWORD type of authentication.

svcusername

The username of the service credential requesting this web service.

svcpassword

The password of the service credential requesting this web service.

     When PASSWORD authtype is used, SKFS uses entries in a previously configured Lightweight Directory Access Protocol (LDAP) or Active Directory (AD) to authenticate the credential (see Manage Credentials under [ SKFS ⇒ Administration ⇒ Security ] for details).

 

operation Description

Value

Explanation

operation

This parameter specifies the type of operation to perform on configuration. Set the operation value to "update" to update any configuration value for the FIDO Server (basis the configuration key).

 

 

payload Description

Value

Explanation

configurations

The array of all the properties that needs to be updated on the SKFS Server. Every JSON object within the array includes three keys: 

  • configkey: This is the name of the configuration that needs to be updated
  • configvalue: The new value for the configuration
  • notes: The plain notes to be documented with the change