Request Passkey Challenge

POST 
/api/web/v1/authentication/passkey

deprecated

Request passkey challenge. This API is deprecated, use /api/web/v2/authentication/users/authenticate/PASSKEY instead.

Request

application/json

Body

required

applicationId string

Unique identifier of the Identity as a Service Authentication API application

Responses

200

Authenticators retrieved successfully

application/json

Schema

Schema

expires int64

fidoChallenge

object

If the authentication challenge is of type FIDO, the FIDOChallenge will contain the FIDO challenge parameters that must be passed to the FIDO token to complete authentication.

allowCredentials string[]

The list of IDs of the FIDO tokens registered for the user. Each value is base-64 encoded.

challenge stringrequired

A random challenge. It is a base-64 encoded value.

timeout int32required

The number of seconds that the client will wait for the FIDO token to respond.

time int64
token string

Example (from schema)

{
  "expires": 0,
  "fidoChallenge": {
    "allowCredentials": [
      "string"
    ],
    "challenge": "string",
    "timeout": 0
  },
  "time": 0,
  "token": "string"
}

400

Bad request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...