Resolver Configuration

The Universal Resolver supports various configuration settings that can be configured per account.

Configuration Setting: universalResolverConfig

This profile setting controls the configuration of the Universal Resolver.

Get Value

The following request will get the universalResolverConfig configuration setting.

curl -X GET "https://profile.godiddy.com/1.0.0/profile/metadata/universalResolverConfig" \
     -H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0"

Set Value

The following request will set the universalResolverConfig configuration setting.

curl -X PUT "https://profile.godiddy.com/1.0.0/profile/metadata/universalResolverConfig" \
     -H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0" \
     -H "Content-Type: application/json" \
     -d '{
           "securityPolicy": {
             "checkValidDidDocument": {
               "defaultAction": "warn"
             },
             "checkMethod": {
               "defaultAction": "warn",
               "deny": ["indy"]
             }
           }
         }'

Supported Fields

The following fields are supported in the universalResolverConfig configuration setting.

The field names contain default values for the corresponding security policies described in Resolver Policies. Some of the settings support allow-lists and deny-lists.

Field	Possible Values
securityPolicy.checkValidDidDocument.defaultAction	ignore, warn, error.
securityPolicy.checkMethod.defaultAction	ignore, warn, error.
securityPolicy.checkMethod.allow	An array containing an allow-list of DID methods. Supports the * wildcard.
securityPolicy.checkMethod.deny	An array containing an deny-list of DID methods. Supports the * wildcard.
securityPolicy.checkKeyType.defaultAction	ignore, warn, error.
securityPolicy.checkKeyType.allow	An array containing an allow-list of key types. Supports the * wildcard.
securityPolicy.checkKeyType.deny	An array containing an deny-list of key types. Supports the * wildcard.
securityPolicy.checkVerificationMethodType.defaultAction	ignore, warn, error.
securityPolicy.checkVerificationMethodType.allow	An array containing an allow-list of verification method types. Supports the * wildcard.
securityPolicy.checkVerificationMethodType.deny	An array containing an deny-list of verification method types. Supports the * wildcard.
securityPolicy.checkLocalDerivedKey.defaultAction	ignore, warn, error.
securityPolicy.checkLocalDuplicateKey.defaultAction	ignore, warn, error.
securityPolicy.checkGlobalDuplicateKey.defaultAction	ignore, warn, error.
securityPolicy.verifyDnsBridge.defaultAction	ignore, warn, error.
securityPolicy.verifyDnsBridge.allow	An array containing an allow-list of domain names. Supports the * wildcard.
securityPolicy.verifyDnsBridge.deny	An array containing an deny-list of domain names. Supports the * wildcard.
securityPolicy.verifyCertificateBridge.defaultAction	ignore, warn, error.
securityPolicy.verifyCertificateBridge.allow	An array containing an allow-list of PEM-encoded trusted X.509 certificates. Supports the * wildcard.
securityPolicy.verifyCertificateBridge.deny	An array containing an deny-list of PEM-encoded trusted X.509 certificates. Supports the * wildcard.

Configuration Setting: universalResolverConfigProfiles

Using this setting, configuration profiles of the universalResolverConfig configuration setting can be defined, which can then be invoked in API calls to the Universal Resolver.

Get Value

The following request will get the universalResolverConfigProfiles configuration setting.

curl -X GET "https://profile.godiddy.com/1.0.0/profile/metadata/universalResolverConfigProfiles" \
     -H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0"

Set Value

The following request will set the universalResolverConfigProfiles configuration setting.

curl -X PUT "https://profile.godiddy.com/1.0.0/profile/metadata/universalResolverConfigProfiles" \
     -H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0" \
     -H "Content-Type: application/json" \
     -d '{
           "strict": {
             "securityPolicy": {
               "checkValidDidDocument": {
                 "defaultAction": "error"
               },
               "checkMethod": {
                 "defaultAction": "error",
                 "deny": ["indy"]
               }
             }
           },
           "lax": {
             "securityPolicy": {
               "checkValidDidDocument": {
                 "defaultAction": "ignore"
               },
               "checkMethod": {
                 "defaultAction": "ignore",
                 "deny": ["indy"]
               }
             }
           }
         }'

With configProfile parameter

A request for a DID URL with this parameter will apply the configuration settings of the selected configuration profile:

curl -X GET "https://api.godiddy.com/1.0.0/universal-resolver/identifiers/did:indy:sovrin:Uarrb25Y6v2jhLCJyqTKE7?configProfile=lax" \
     -H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0"