Authenticate an SSH key

Creates a new SSH key for the authenticated user.

GET
https://identity.krystal.io/api/v1/ssh_keys/authenticate

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

ssh_key Required

SSHKeyLookup None

ip_address Required

String None

Potential Errors

The following errors may occur during this request.

Details HTTP status

ip_address_denied

The given IP address is not authorised for the given SSH key

403 Forbidden

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    user_id: String
}