Skip to main content
REST API reference

Retrieve a WebAuthn supported algorithms entry

PDFs

GET /security/webauthn/supported-algorithms/{owner.uuid}/{algorithm.name}

Introduced In: 9.16

Retrieves a WebAuthn supported algorithms entry.

  • security webauthn supported-algorithms show

Parameters

Name Type In Required Description

owner.uuid

string

path

True

Used to identify a cluster or an SVM.

algorithm.name

string

path

True

Algorithm name.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

self_link

algorithm

algorithm

owner

svm_reference

SVM, applies only to SVM-scoped objects.

scope

string

Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "algorithm": {
    "id": -7,
    "name": "ES-256",
    "type": "string"
  },
  "owner": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "scope": "string"
}

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

algorithm

Name Type Description

id

integer

Algorithm ID.

name

string

Algorithm name.

type

string

Algorithm type.

_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.