Skip to main content
REST API reference

Retrieve a WebAuthn credentials entry

PDFs

GET /security/webauthn/credentials/{owner.uuid}/{username}/{index}/{relying_party.id}

Introduced In: 9.16

Retrieves a WebAuthn credentials entry.

  • security webauthn credentials show

Parameters

Name Type In Required Description

owner.uuid

string

path

True

Used to identify a cluster or an SVM.

username

string

path

True

Username.

index

integer

path

True

Index.

relying_party.id

string

path

True

Relying Party ID.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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.
Example response 
{
  "_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

self

href

credential

Name Type Description

id_sha

string

SHA-256 Hashed representation of Credential ID.

type

string

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

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.

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.