doc/api/methods/api_client_authorizations.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "api_client_authorizations"
   6
   7 ...
   8
   9 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/api_client_authorizations@
  10
  11 Object type: @gj3su@
  12
  13 Example UUID: @zzzzz-gj3su-0123456789abcde@
  14
  15 h2. Resource
  16
  17 The @api_client_authorizations@ resource stores the API tokens that have been issued to permit access the API server.
  18
  19 An ApiClientAuthorization is *not* a generic Arvados resource.  The full list of properties that belong to an ApiClientAuthorization is:
  20
  21 table(table table-bordered table-condensed).
  22 |_. Attribute|_. Type|_. Description|_. Example|
  23 |uuid|string|An identifier used to refer to the token without exposing the actual token.||
  24 |api_token|string|The actual token string that is expected in the Authorization header.||
  25 |api_client_id|integer|-||
  26 |user_id|integer|-||
  27 |created_by_ip_address|string|-||
  28 |last_used_by_ip_address|string|The network address of the most recent client using this token.||
  29 |last_used_at|datetime|Timestamp of the most recent request using this token.||
  30 |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.||
  31 |owner_uuid|string|The user associated with the token.  All operations using this token are checked against the permissions of this user.||
  32 |scopes|array|A list of resources this token is allowed to access.  A scope of ["all"] allows all resources.  See "API Authorization":{{site.baseurl}}/api/tokens.html#scopes for details.||
  33
  34 h2. Methods
  35
  36 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  37
  38 Required arguments are displayed in %{background:#ccffcc}green%.
  39
  40 h3(#create). create
  41
  42 Create a new ApiClientAuthorization.
  43
  44 Regular users may only create self-owned API tokens, but may provide a restricted "scope":{{site.baseurl}}/api/tokens.html#scopes .  Administrators may create API tokens corresponding to any user.
  45
  46 Arguments:
  47
  48 table(table table-bordered table-condensed).
  49 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  50 |api_client_authorization|object||query||
  51
  52 h3. create_system_auth
  53
  54 create_system_auth api_client_authorizations
  55
  56 Arguments:
  57
  58 table(table table-bordered table-condensed).
  59 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  60 |api_client_id|integer||query||
  61 |scopes|array||query||
  62
  63 h3. delete
  64
  65 Delete an existing ApiClientAuthorization.
  66
  67 Arguments:
  68
  69 table(table table-bordered table-condensed).
  70 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  71 {background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
  72
  73 h3. get
  74
  75 Gets an ApiClientAuthorization's metadata by UUID.
  76
  77 Arguments:
  78
  79 table(table table-bordered table-condensed).
  80 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  81 {background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
  82
  83 h3. list
  84
  85 List api_client_authorizations.
  86
  87 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  88
  89 h3. update
  90
  91 Update attributes of an existing ApiClientAuthorization.
  92
  93 Arguments:
  94
  95 table(table table-bordered table-condensed).
  96 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  97 {background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
  98 |api_client_authorization|object||query||