api_client_authorizations

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

Object type: gj3su

Example UUID: zzzzz-gj3su-0123456789abcde

Resource

The api_client_authorizations resource stores the API tokens that have been issued to permit access the API server.

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

Attribute	Type	Description	Example
uuid	string	An identifier used to refer to the token without exposing the actual token.
api_token	string	The actual token string that is expected in the Authorization header.
created_by_ip_address	string	-
last_used_by_ip_address	string	The network address of the most recent client using this token.
last_used_at	datetime	Timestamp of the most recent request using this token.
expires_at	datetime	Time at which the token is no longer valid. May be set to a time in the past in order to immediately expire a token.
owner_uuid	string	The user associated with the token. All operations using this token are checked against the permissions of this user.
scopes	array	A list of resources this token is allowed to access. A scope of [“all”] allows all resources. See API Authorization for details.

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

Regular users may only create self-owned API tokens, but may provide a restricted scope . Administrators may create API tokens corresponding to any user.

Arguments:

Argument	Type	Description	Location	Example
api_client_authorization	object		query

create_system_auth

create_system_auth api_client_authorizations

Arguments:

Argument	Type	Description	Location	Example
api_client_id	integer		query
scopes	array		query

current

Return the full record associated with the provided API token. This endpoint is often used to check the validity of a given token.

Arguments:

Argument	Type	Description	Location	Example

delete

Delete an existing ApiClientAuthorization.

Arguments:

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

get

Gets an ApiClientAuthorization’s metadata by UUID.

Arguments:

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

list

List api_client_authorizations.

See common resource list method.

update

Update attributes of an existing ApiClientAuthorization.

Arguments:

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

---

Previous: groups Next: links