승인
Enrollment Token API에 액세스하는 데 필요한 승인은 Chrome Browser Cloud Management'sTakeout API Service Script 가이드에 자세히 설명되어 있습니다. 사용자가 가이드와 동일한 액세스 단계를 수행하여 액세스 토큰을 가져와야 합니다.
ChromeEnrollmentToken
ChromeEnrollmentToken은 Chrome 브라우저 등록을 식별하는 데 사용되는 문자열입니다.
리소스 표현
Directory API의 ChromeEnrollmentToken 리소스에 사용되는 JSON 템플릿은 다음과 같습니다.
{
"kind": "admin#directory#chromeEnrollmentToken",
"orgUnitPath": 문자열,
"token": 문자열,
"tokenPermanentId": 문자열,
"customerId": 문자열,
"orgUnitPath": 문자열,
"state": enum {
"active",
"expired",
"revoked",
}
"expiration": oneof {
"expireTime": 날짜/시간,
"ttl": 기간
}
"creatorId": 문자열,
"creationTime": 날짜/시간,
"revokerId": 문자열,
"revokeTime": 날짜/시간,
"tokenType": enum {
"chromeBrowser"
}
}
API 호출
계정의 모든 등록 토큰 보기
조직 단위 계정의 모든 Chrome 등록 토큰을 나열하려면 다음 GET 요청을 사용하고 '승인' 섹션에 따라 가져온 액세스 토큰을 포함합니다.
참고: 가독성을 위해 이 코드 샘플에는 줄바꿈이 포함되어 있습니다.
GET
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens?query=
{query_string}&pageSize={number_of_results_to_return}
&pageToken={page_token_from_previous_request}&orgUnitPath={/org-unit-path}
- customerId는 고객 Google 계정의 고유 식별자입니다.
- 계정 관리자를 가장할 때는 계정의 customerId를 나타내는 문자열 my_customer를 사용할 수도 있습니다. customerId 값을 가져오기 위한 다른 방법으로 사용자 검색 작업을 사용할 수 있습니다. 관리자 이메일 주소 또는 작업의 userKey 경로 매개변수에 포함된 관리자 고유 사용자 ID 값을 사용하세요.
요청에 사용할 수 있는 모든 페이로드 매개변수는 다음과 같습니다.
| 매개변수 | 필수 | 유형 | 설명 |
|---|---|---|---|
| orgUnitPath | 선택사항 | 문자열 | 특정 조직 단위에 생성된 등록 토큰만 표시합니다. 이 필드가 지정되지 않으면 이 고객의 모든 등록 토큰이 표시됩니다. |
| pageSize | 선택사항 | int | 반환할 결과의 최대 수입니다. 최대 기본값은 100입니다. |
| pageToken | 선택사항 | 문자열 | pageToken 쿼리 매개변수는 쿼리 결과의 다음 페이지를 요청하는 데 사용됩니다. 후속 요청의 pageToken 쿼리 매개변수는 이전 응답의 nextPageToken입니다. 참고: page_token 필드가 제공된 요청은 쿼리 값 및 page_token을 생성한 요청과 org_unit_path 필드 값이 동일해야 합니다. |
| query | 선택사항 | 문자열 | 표시된 토큰을 필터링하는 문자열을 검색합니다. 목록 페이지 쿼리 언어의 형식은 아래 섹션에 설명되어 있습니다(필터 쿼리 언어). |
예
요청 예
GET https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens?pageSize=1&orgUnitPath=”/Org-unit-path”
JSON 응답
요청이 성공하면 HTTP 200 상태 코드가 반환됩니다. 응답에는 상태 코드와 함께 Chrome 등록 토큰 속성이 반환됩니다.
{
kind: "admin#directory#chromeEnrollmentTokens",
"chrome_enrollment_tokens": [
{
"tokenId": "token_id_value",
"tokenPermanentId": "token_Permanent_id_value",
"kind": "admin#directory#chromeEnrollmentToken",
"orgUnitPath": "/Org-unit-path",
"state": "active",
"creator_id": “unique_id_of_user",
"create_time": "2020-04-30T19:22:44Z",
"tokenType": "chromeBrowser",
}
],
"nextPageToken": "abcdefghijkl123"
}
쿼리 언어 필터링
목록 요청에 'query' 매개변수를 사용할 때 쿼리의 모든 단어가 다음 매개변수 중 하나와 일치해야 결과가 일치로 간주됩니다. 반환된 토큰의 범위를 검색어의 필드 값과 일치하도록 지정할 수 있습니다. 쿼리에 연산자(필드)가 지정되지 않으면 모든 등록 토큰이 검색됩니다.
예를 들어 쿼리가 다음과 같은 경우:
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED",
다음과 같은 등록 토큰이 반환됩니다.
{
"tokenId": "token_id_value",
"tokenPermanentId": "token_Permanent_id_value",
"kind": "admin#directory#chromeEnrollmentToken",
"orgUnitPath": "/Org-unit-path",
“tokenState”: “revoked”,
“creatorId”: “unique_id_of_user”,
"create_time": "2020-04-30T19:22:44Z",
"tokenType": "chromeBrowser",
}
다음 필드를 지정하여 검색어를 특정 필드로 타겟팅할 수 있습니다.
| 필드 | 설명 |
|---|---|
| device_type | 등록 토큰이 사용되는 기기 유형입니다. 현재는 CHROME_BROWSER만 지원됩니다. |
| token_state | 등록 토큰의 상태입니다. 지원되는 값은 REVOKED, ACTIVE, EXPIRED입니다. |
등록 토큰 만들기
조직 단위에 Chrome 등록 토큰을 만들려면 다음 POST 요청을 사용하고 '승인' 섹션에 따라 얻은 액세스 토큰을 포함하세요.
참고: 가독성을 위해 이 코드 샘플에는 줄바꿈이 포함되어 있습니다.
POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens
- customerId는 고객 Google 계정의 고유 식별자입니다.
- 계정 관리자를 가장할 때는 계정의 customerId를 나타내는 문자열 my_customer를 사용할 수도 있습니다. customerId 값을 가져오기 위한 다른 방법으로 사용자 검색 작업을 사용할 수 있습니다. 관리자 이메일 주소 또는 작업의 userKey 경로 매개변수에 포함된 관리자 고유 사용자 ID 값을 사용하세요.
요청에 사용할 수 있는 모든 페이로드 매개변수는 다음과 같습니다.
| 매개변수 | 필수 | 유형 | 설명 |
|---|---|---|---|
| expire_time | 선택사항 | 문자열 | 'yyyy-MM-ddThh:mm:ssZ' 형식으로 생성된 등록 토큰의 만료 시간입니다. 이 필드가 지정되지 않으면 등록 토큰은 사용자가 취소할 때까지 유효합니다. |
| org_unit_path | 선택사항 | 문자열 | 등록 토큰을 만들 조직 단위입니다. 이 필드가 지정되지 않으면 등록 토큰이 루트 조직 단위에 생성됩니다. |
| token_type | 필수 | 문자열 | 등록 토큰을 만들 Chrome 기기의 유형입니다. 현재는 'CHROME_BROWSER'만 지원됩니다. |
| ttl | 선택사항 | 문자열 | 생성된 등록 토큰의 수명으로, 's' 접미사를 가지며 초 단위로 인코딩됩니다. 예를 들어 토큰이 1시간 동안 유효하려면 이 필드는 '3600s'로 설정되어야 합니다. 이 필드가 지정되지 않으면 등록 토큰은 사용자가 취소할 때까지 유효합니다. |
예
요청 예
POST https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens
{
"token_type": "CHROME_BROWSER",
"org_unit_path": "/org-unit-path",
"expire_time": "2021-04-30T19:22:44Z",
}
JSON 응답
요청이 성공하면 HTTP 200 상태 코드가 반환됩니다. 응답에는 상태 코드와 함께 Chrome 등록 토큰 속성이 반환됩니다.
{
"tokenId": "token_id_value",
"tokenPermanentId": "token_Permanent_id_value",
"kind": "admin#directory#chromeEnrollmentToken",
"orgUnitPath": "/Org-unit-path",
"state": "active",
"creatorId”: "unique_id_of_user",
"create_time": "2020-04-30T19:22:44Z",
"expire_time": "2021-04-30T19:22:44Z",
"tokenType": "chromeBrowser",
}
등록 토큰 취소
등록 토큰을 취소하려면 다음 POST 요청을 사용하고 '승인' 섹션에 따라 얻은 액세스 토큰을 포함합니다.
참고: 가독성을 위해 이 코드 샘플에는 줄바꿈이 포함되어 있습니다.
POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens/{tokenPermanentId}:revoke
- customerId는 고객 Google 계정의 고유 식별자입니다.
- 계정 관리자를 가장할 때는 계정의 customerId를 나타내는 문자열 my_customer를 사용할 수도 있습니다. customerId 값을 가져오기 위한 다른 방법으로 사용자 검색 작업을 사용할 수 있습니다. 관리자 이메일 주소 또는 작업의 userKey 경로 매개변수에 포함된 관리자 고유 사용자 ID 값을 사용하세요.
- tokenPermanentId는 등록 토큰의 고유 식별자이며 '목록' 또는 '만들기' 응답의 'tokenPermanentId' 필드에서 찾을 수 있습니다.
예
요청 예
POST https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens/token_permanent_id_value:revoke
JSON 응답
요청이 성공하면 HTTP 200 상태 코드가 반환됩니다.