authorized_keys

API endpoint base: https://qr1hi.arvadosapi.com/arvados/v1/authorized_keys

Object type: fngyi

Example UUID: zzzzz-fngyi-0123456789abcde

Resource

The authorized_keys resource stores SSH public keys which grant access to virtual machines or git repositories on the Arvados cluster as the user in authorized_user_uuid.

Each AuthorizedKey has, in addition to the Common resource fields:

Attribute Type Description Example
name string A name to help the user manage their keys.
key_type string Public key type, currently only supports “SSH
authorized_user_uuid string The user to which this key belongs. Authentication using this key authenticates as this user.
public_key text The actual public key material, e.g., from ~/.ssh/id_rsa.pub
expires_at datetime Expiration date after which the key is no longer valid.

Methods

See Common resource methods for more information about create, delete, get, list, and update.

Required arguments are displayed in green.

create

Create a new AuthorizedKey.

Arguments:

Argument Type Description Location Example
authorized_key object query

delete

Delete an existing AuthorizedKey.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the AuthorizedKey in question. path

get

Gets a AuthorizedKey’s metadata by UUID.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the AuthorizedKey in question. path

list

List authorized_keys.

See common resource list method.

update

Update attributes of an existing AuthorizedKey.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the AuthorizedKey in question. path
authorized_key object query

Previous: api_clients Next: groups

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.