as-userヘッダー

必須のガイド

as-userヘッダーを使用すると、OAuth 2.0アプリケーションは別のユーザーの代理になることができます。

curl https://api.box.com/2.0/folders/0 \
    -H "as-user: [USER_ID]"
    -H "authorization: Bearer [ACCESS_TOKEN]"

この場合、ユーザーIDはユーザーのBox識別子です。どのユーザーでも、ユーザーIDは、管理者だけが利用可能なGET /usersエンドポイントを介して確認できます。また、認証済みのユーザーセッションでGET /users/meエンドポイントを呼び出して確認することもできます。

as-userヘッダーを使用するには、いくつかの要件があります。最初に、アプリケーションは、開発者コンソールで、ユーザーとして操作を行うよう構成する必要があります。

さらに、認証済みユーザーは、管理者権限を持つユーザー、つまり、管理者、共同管理者、またはサービスアカウントのいずれかである必要があります。共同管理者にも、「ユーザーを管理する」権限のスコープが必要です。詳細については、ユーザータイプのガイドを参照してください。

var user_client = new BoxClient(config, session, asUser: '[USER_ID]');

client.asUser([USER_ID]");
// client.asSelf();

user_to_impersonate = client.user(user_id='[USER_ID]')
user_client = client.as_user(user_to_impersonate)

client.asUser('[USER_ID]');
// client.asSelf();

SDKには、他のユーザーに対して新しいクライアントを作成するものもあれば、既存のクライアントを変更して、そのクライアントが元のユーザーに対して認証される状態に戻せるようにするものもあることに注意してください。