api_clients

API endpoint base: https://pirca.arvadosapi.com/arvados/v1/api_clients

Object type: ozdt8

Example UUID: zzzzz-ozdt8-0123456789abcde

Resource

The “api_clients” resource determines if web applications that have gone through the browser login flow may create or list API tokens.

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

Attribute	Type	Description	Example
name	string
url_prefix	string
is_trusted	boolean	Trusted by users to handle their API tokens (ApiClientAuthorizations).

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

Arguments:

Argument	Type	Description	Location	Example
api_client	object		query

delete

Delete an existing ApiClient.

Arguments:

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

get

Gets a ApiClient’s metadata by UUID.

Arguments:

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

list

List api_clients.

See common resource list method.

update

Update attributes of an existing ApiClient.

Arguments:

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

---

Previous: authorized_keys Next: user_agreements