Skip to main content
REST API reference

Retrieve a WebAuthn global setting entry

PDFs

GET /security/webauthn/global-settings/{owner.uuid}

Introduced In: 9.16

Retrieves a WebAuthn global setting entry.

  • security webauthn show

Parameters

Name Type In Required Description

owner.uuid

string

path

True

Used to identify a cluster or an SVM.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

self_link

attestation

string

Attestation conveyance type.

owner

svm_reference

SVM, applies only to SVM-scoped objects.

require_rk

boolean

Specifies whether the resident key is required.

resident_key

string

Resident key.

scope

string

Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects.

timeout

integer

The timeout interval for the WebAuthn request, in milliseconds.

user_verification

string

User verification.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "attestation": "none",
  "owner": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "require_rk": "",
  "resident_key": "discouraged",
  "scope": "string",
  "timeout": 600000,
  "user_verification": "discouraged"
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string
Name Type Description

self

href

_links

Name Type Description

self

href

svm_reference

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.