Product Documentation

 The following request body is sent during the ROR web service call with update operation.

  • URL: https://<FQDN>:<PORT>/skfs/rest/ror
  • HTTP Method: POST

  • FIDO2_0 request body:
    {
        "svcinfo": {
            "did": 1,
            "protocol": "FIDO2_0",
            "authtype": "PASSWORD",
            "svcusername": "fidoadminuser",
            "svcpassword": "Abcd1234!"
        },
        "operation": "update",
        "payload": {
            "webOrigins": [
                {
                    "ogid": 1,
                    "status": "inactive"
                },
                {
                    "ogid": 2,
                    "status": "inactive"
                }
            ]
        }
    }

 

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 ROR origins. Set the operation value to "update" to update the status to "active/inactive"

 

payload Description

Value

Explanation

webOrigins

An array of JSON Objects containing ogid and status

ogid

The origin ID refers to the unique ID that was assigned to the Related web origin when it was generated

status

Status that should be updated for the related web origin. Values: active | inactive