Skip to main content
REST API reference

Retrieve all WebAuthn credentials entries

Retrieves all WebAuthn credentials entries to view the configured WebAuthn credentials associated with your system.

HTTP method and endpoint

GET /security/webauthn/credentials

Introduced in

ONTAP 9.16

  • security webauthn credentials show

Parameters

Name Type In Required Description

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 15

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

collection_links

num_records

integer

Number of records.

records

array[webauthn_credentials]

Example response
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "creation_time": "2024-08-05 22:38:55 -0400",
      "credential": {
        "id_sha": "xxxxxxxxxxxxxxxxxxxxxxebfb30f20bf6db74xxxxxxxxxxxxxxxxxxxxxxxxxx",
        "type": "string"
      },
      "display_name": "admin",
      "index": 0,
      "last_used_time": "2024-08-05 22:48:55 -0400",
      "owner": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "public_key": {
        "algorithm": "ES-256",
        "value": "xxxxxxxxxxxxxxxxxxxxxe5sZohRRv2B10JjjALXmGRmEfFIxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxYr2+w=="
      },
      "relying_party": {
        "id": "example.com",
        "name": "example.com"
      },
      "scope": "string",
      "username": "admin"
    }
  ]
}

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

next

href

self

href

Name Type Description

self

href

credential

Name Type Description

id_sha

string

SHA-256 Hashed representation of Credential ID.

type

string

Credential type.

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.

public_key

Name Type Description

algorithm

string

Public key algorithm.

value

string

Public key value.

relying_party

Name Type Description

id

string

Relying Party ID.

name

string

Relying Party Name.

webauthn_credentials

Name Type Description

_links

self_link

creation_time

string

Date and time indicating when this entry was created.

credential

credential

display_name

string

Display name.

index

integer

Index.

last_used_time

string

Date and time indicating when this entry was last used.

owner

svm_reference

SVM, applies only to SVM-scoped objects.

public_key

public_key

relying_party

relying_party

scope

string

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

username

string

Username.

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.