---
layout: default
navsection: api
navmenu: API Methods
title: "api_client_authorizations"

...

See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html

API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/api_client_authorizations@

Required arguments are displayed in %{background:#ccffcc}green%.

h2. Resource

An ApiClientAuthorization is not a generic Arvados resource.  The full list of properties that belong to an ApiClientAuthorization is:

table(table table-bordered table-condensed).
|_. Attribute|_. Type|_. Description|_. Example|
|api_token|string|||
|api_client_id|integer|||
|user_id|integer|||
|created_by_ip_address|string|||
|last_used_by_ip_address|string|||
|last_used_at|datetime|||
|expires_at|datetime|||
|default_owner_uuid|string|||
|scopes|array|||

h2. Methods

h3. create

Create a new ApiClientAuthorization.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|api_client_authorization|object||query||

h3. create_system_auth

create_system_auth api_client_authorizations

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|api_client_id|integer||query||
|scopes|array||query||

h3. delete

Delete an existing ApiClientAuthorization.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||

h3. get

Gets a ApiClientAuthorization's metadata by UUID.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||

h3. list

List api_client_authorizations.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|limit|integer (default 100)|Maximum number of api_client_authorizations to return.|query||
|order|string|Order in which to return matching api_client_authorizations.|query||
|filters|array|Conditions for filtering api_client_authorizations.|query||

h3. update

Update attributes of an existing ApiClientAuthorization.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
|api_client_authorization|object||query||