Skip to content

Commit 4d5342c

Browse files
authored
Add information on CCG app (#603)
* Add information on CCG app * Correct formatting * Correct formatting * Remove incorrect info * Add more examples * Correct info
1 parent 98a4422 commit 4d5342c

File tree

1 file changed

+20
-3
lines changed
  • content/guides/authentication/client-credentials

1 file changed

+20
-3
lines changed

content/guides/authentication/client-credentials/index.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,23 @@ If you would like to authenticate as the application's [Service Account][sa]:
4646
- set `box_subject_type` to `enterprise`
4747
- set `box_subject_id` to the enterprise ID
4848

49-
If you would like to authenticate as a Managed User:
49+
<Samples id='x_auth' variant='with_client_credentials' ></Samples>
50+
51+
If you would like to authenticate as an admin or a managed user:
5052

5153
- set `box_subject_type` to `user`
5254
- set `box_subject_id` to the user ID
55+
- enable **App + Enterprise Access** and **Generate User Access Tokens** Box [Developer Console][devconsole]
5356

54-
<Samples id='x_auth' variant='with_client_credentials' ></Samples>
57+
<Samples id='x_auth' variant='with_ccg_admin_managed_user' ></Samples>
58+
59+
If you would like to authenticate as any application user:
60+
61+
- set `box_subject_type` to `user`
62+
- set `box_subject_id` to the user ID
63+
- enable **Generate User Access Tokens** in the Box [Developer Console][devconsole]
64+
65+
<Samples id='x_auth' variant='with_ccg_app_user' ></Samples>
5566

5667
## Common Errors
5768

@@ -69,7 +80,13 @@ This error indicates either:
6980

7081
- the client ID and client secret passed are incorrect or are not for the same application,
7182

72-
- the `box_subject_id` cannot be used based on the selected [application access][aa]. For example, if you send in a `box_subject_type` of `enterprise` and your application is configured for App Access Only, the `grant credentials are invalid` error will be returned,
83+
- the `box_subject_id` cannot be used based on the selected [application access][aa].
84+
85+
<Message warning>
86+
87+
A CCG app with App Access Only can send in the `box_subject_type` of `enterprise` to authenticate as its service account, but it can't authenticate as a managed user or an admin.
88+
89+
</Message>
7390

7491
- to use a `box_subject_type` of `user`, your application should be configured to generate user access tokens in the **Advanced Features** section of the **Configuration tab**.
7592

0 commit comments

Comments
 (0)