アクセストークンをリクエスト

このリソースは、バージョン2024.0のエンドポイントで使用されています。詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

ボディ

application/x-www-form-urlencoded

新しいOAuth 2.0トークンのリクエスト。

grant_type

enum<string>

必須

クライアント側で取得される承認コード、更新トークン、JWTアサーション、クライアント資格情報許可、またはトークンのダウンスコープを目的とするその他のアクセストークンを使用して行われているリクエストのタイプ。

利用可能なオプション:

authorization_code,

refresh_token,

client_credentials,

urn:ietf:params:oauth:grant-type:jwt-bearer,

urn:ietf:params:oauth:grant-type:token-exchange

例:

"authorization_code"

client_id

string

アクセストークンをリクエストしているアプリケーションのクライアントID。

grant_typeにauthorization_code、client_credentials、またはurn:ietf:params:oauth:grant-type:jwt-bearerが指定されている場合に組み合わせて使用されます。

例:

"ly1nj6n11vionaie65emwzk575hnnmrk"

client_secret

string

アクセストークンをリクエストしているアプリケーションのクライアントシークレット。

grant_typeにauthorization_code、client_credentials、またはurn:ietf:params:oauth:grant-type:jwt-bearerが指定されている場合に組み合わせて使用されます。

例:

"hOzsTeFlT6ko0dme22uGbQal04SBPYc1"

code

string<token>

ユーザーが自身の代わりにAPIコールを行う権限をアプリケーションに付与した後、ブラウザリダイレクト時にBoxからアプリケーションに渡されるクライアント側承認コード。

authorization_codeとの組み合わせでgrant_typeとして使用されます。

例:

"n22JPxrh18m4Y0wIZPIqYZK7VRrsMTWW"

refresh_token

string<token>

新しいアクセストークンを入手するために使用される更新トークン。

refresh_tokenとの組み合わせでgrant_typeとして使用されます。

例:

"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ"

assertion

string<jwt>

新しいアクセストークンをリクエストするJWTアサーション。

urn:ietf:params:oauth:grant-type:jwt-bearerとの組み合わせでgrant_typeとして使用されます。

例:

"xxxxx.yyyyy.zzzzz"

subject_token

string<token>

ダウンスコープされたトークンと交換するためのトークン。通常のアクセストークン、JWTアサーション、アプリトークンのいずれかを使用できます。

urn:ietf:params:oauth:grant-type:token-exchangeとの組み合わせでgrant_typeとして使用されます。

例:

"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ"

subject_token_type

enum<string>

渡されるsubject_tokenのタイプ。

urn:ietf:params:oauth:grant-type:token-exchangeとの組み合わせでgrant_typeとして使用されます。

利用可能なオプション:

urn:ietf:params:oauth:token-type:access_token

例:

"urn:ietf:params:oauth:token-type:access_token"

actor_token

string<token>

注釈トークンを作成するためのトークン。これはJWTアサーションです。

urn:ietf:params:oauth:grant-type:token-exchangeとの組み合わせでgrant_typeとして使用されます。

例:

"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ"

actor_token_type

enum<string>

渡されるactor_tokenのタイプ。

urn:ietf:params:oauth:grant-type:token-exchangeとの組み合わせでgrant_typeとして使用されます。

利用可能なオプション:

urn:ietf:params:oauth:token-type:id_token

例:

"urn:ietf:params:oauth:token-type:id_token"

scope

string<space_delimited_list>

新しいアクセストークンに割り当てるスコープのスペース区切りリスト。

subject_tokenは、これらすべてのスコープを持っている必要があります。そうでない場合、この呼び出しを行うと、401 Unauthorizedエラーになります。

例:

"item_upload item_preview base_explorer"

resource

string<url>

トークンを生成するファイルの完全なURL。

例:

"https://api.box.com/2.0/files/123456"

box_subject_type

enum<string>

client_credentialsとの組み合わせでgrant_typeとして使用されます。

利用可能なオプション:

enterprise,

user

例:

"enterprise"

box_subject_id

string

grant_typeにclient_credentialsが指定されている場合に組み合わせて使用されます。値はbox_subject_typeによって決まります。userの場合はユーザーIDを使用し、enterpriseの場合はEnterprise IDを使用します。

例:

"123456789"

box_shared_link

string<url>

トークンが生成されるファイルまたはフォルダの共有リンクの完全なURL。

例:

"https://cloud.box.com/s/123456"

レスポンス

Authorization: Bearer <Token>のように承認ヘッダー内でトークンを渡すことによって認証済みのAPIコールを行うために使用できる新しいアクセストークンを返します。

認証済みのAPIコールを行うために使用できるトークン。

access_token

string<token>

リクエストされたアクセストークン。

例:

"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ"

expires_in

integer<int64>

このトークンが期限切れになるまでの秒数。

例:

3600

token_type

enum<string>

返されるアクセストークンのタイプ。

利用可能なオプション:

bearer

例:

"bearer"

restricted_to

リソースのスコープ · object[]

このアクセストークンで許可される権限を返します。これにより、リソース (ファイルやフォルダなど) のリストと、各リソースで許可されるスコープが提供されます。

表示子属性

refresh_token

string<token>

このアクセストークンの更新トークン。現在のトークンの有効期限が切れて新しいアクセストークンをリクエストするときに使用できます。

例:

"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ"

issued_token_type

enum<string>

返されたダウンスコープ済みアクセストークンのタイプ。これは、アクセストークンがダウンスコープされている場合にのみ返されます。

利用可能なオプション:

urn:ietf:params:oauth:token-type:access_token

例:

"urn:ietf:params:oauth:token-type:access_token"