X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/a12e4d36901ab3b3027f1168f1ea06b26122829e..c59af50bc2f7a366cd12a8dd6fc7d7e3b1c32480:/doc/api/tokens.html.textile.liquid diff --git a/doc/api/tokens.html.textile.liquid b/doc/api/tokens.html.textile.liquid index 3437003a18..1846d60b0e 100644 --- a/doc/api/tokens.html.textile.liquid +++ b/doc/api/tokens.html.textile.liquid @@ -49,9 +49,11 @@ h2(#scopes). Scopes Scopes can restrict a token so it may only access certain resources. This is in addition to normal permission checks for the user associated with the token. -Each entry in scopes consists of a @request_method@ and @request_path@, where the @request_method@ is a HTTP method (one of @GET@, @POST@, @PUT@ or @DELETE@) and @request_path@ is the request URI. A given request is permitted if it matches a scopes exactly, or the scope ends with @/@ and the request string is a prefix of the scope. +Each entry in scopes consists of a @request_method@ and @request_path@. The @request_method@ is a HTTP method (one of @GET@, @POST@, @PATCH@ or @DELETE@) and @request_path@ is the request URI. A given request is permitted if it matches a scopes exactly, or the scope ends with @/@ and the request string is a prefix of the scope. -As a special case, a scope of ["all"] allows all resources. +As a special case, a scope of @["all"]@ allows all resources. This is the default if no scope is given. + +Using scopes is also described on the "Securing API access with scoped tokens":{{site.baseurl}}/admin/scoped-tokens.html page of the admin documentation. h3. Scope examples