Autorisation
L'autorisation requise pour accéder à l'API Enrollment Token est détaillée dans le guide Chrome Browser Cloud Management'sTakeout API Service Script. Les utilisateurs doivent procéder de la même manière pour récupérer un jeton d'accès.
ChromeEnrollmentToken
ChromeEnrollmentToken est une chaîne permettant d'identifier l'enregistrement d'un navigateur Chrome.
Représentation de la ressource
Le modèle JSON suivant est utilisé pour la ressource ChromeEnrollmentToken dans l'API Directory:
{
"kind": "admin#directory#chromeEnrollmentToken",
"orgUnitPath": chaîne,
"token": chaîne,
"tokenPermanentId": chaîne,
"customerId": chaîne,
"orgUnitPath": chaîne,
"state": énumération {
"active",
"expired",
"revoked",
}
"expiration": oneof {
"expireTime": date et heure,
"ttl": durée
}
"creatorId": chaîne,
"creationTime": date et heure,
"revokerId": chaîne,
"revokeTime": date/heure,
"tokenType": énumération {
"chromeBrowser"
}
}
Appeler l'API
Répertorier tous les jetons d'inscription pour un compte
Pour lister tous les jetons d'inscription Chrome pour un compte dans une unité organisationnelle, utilisez la requête GET suivante et incluez le jeton d'accès obtenu en suivant la section "Autorisation".
Remarque : Des retours à la ligne ont été inclus dans cet exemple de code pour le rendre plus lisible.
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" est un identifiant unique du compte Google du client.
- Pour emprunter l'identité d'un administrateur de compte, vous pouvez également utiliser la chaîne "my_customer", qui représente l'ID client de votre compte. L'opération de récupération d'un utilisateur permet également d'obtenir la valeur "customerId". Utilisez votre adresse e-mail d'administrateur ou la valeur de votre identifiant utilisateur unique d'administrateur dans le paramètre de chemin d'accès userKey de l'opération.
Vous trouverez ci-dessous la liste de tous les paramètres de charge utile pouvant être utilisés dans la requête :
| Paramètre | Obligatoire | Type | Description |
|---|---|---|---|
| orgUnitPath | facultatif | chaîne | Ne répertoriez que les jetons d'inscription créés dans une unité organisationnelle en particulier. Si ce champ n'est pas spécifié, tous les jetons d'inscription de ce client sont répertoriés. |
| pageSize | facultatif | entier | Nombre maximal de résultats sur une page. La valeur maximale par défaut est 100. |
| pageToken | facultatif | chaîne | Le paramètre de requête pageToken permet de demander la page suivante des résultats de la requête. Le paramètre pageToken de la requête suivante correspond au paramètre nextPageToken de votre réponse précédente. Remarque : Les requêtes dont le champ "page_token" est fourni doivent avoir la même valeur dans les champs "query" et "org_unit_path" que la requête ayant généré le paramètre "page_token". |
| query | facultatif | chaîne | Chaîne de recherche servant à filtrer les jetons répertoriés. Le format du langage de requête de la page de liste est décrit dans la section ci-dessous (Langage de requête du filtre). |
Exemple
Exemple de requête
GET https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens?pageSize=1&orgUnitPath="/Org-unit-path"
Réponse JSON
Une requête réussie affiche le code d'état HTTP 200. Outre le code d'état, la réponse affiche les propriétés Chrome Enrollment Token :
{
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"
}
Langage de requête du filtre
Lorsque vous utilisez le paramètre "query" dans une requête de liste, chaque terme de la requête doit correspondre à l'un des paramètres suivants pour que les résultats soient considérés comme une correspondance. Vous pouvez spécifier que les jetons renvoyés doivent être affinés pour correspondre à la valeur du champ du terme. Si vous ne spécifiez aucun opérateur (champ) dans la requête, la recherche trouvera tous les jetons d'inscription.
Par exemple, si votre requête est :
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED",
les jetons d'inscription affichés seront semblables à ce qui suit :
{
"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",
}
Vous pouvez spécifier les champs suivants afin de cibler votre recherche sur un champ précis :
| Champ | Description |
|---|---|
| device_type | Type d'appareil pour lequel les jetons d'inscription sont utilisés. Actuellement, seul CHROME_BROWSER est accepté. |
| token_state | État d'un jeton d'inscription. Les valeurs acceptées sont "REVOKED", "ACTIVE" et "EXPIRED". |
Créer un jeton d'inscription
Pour créer un jeton d'inscription Chrome dans une unité organisationnelle, utilisez la requête POST ci-dessous et incluez le jeton d'accès obtenu en suivant les instructions de la section "Autorisation".
Remarque : Des retours à la ligne ont été inclus dans cet exemple de code pour le rendre plus lisible.
POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens
- "customerId" est un identifiant unique du compte Google du client.
- Pour emprunter l'identité d'un administrateur de compte, vous pouvez également utiliser la chaîne "my_customer", qui représente l'ID client de votre compte. L'opération de récupération d'un utilisateur permet également d'obtenir la valeur "customerId". Utilisez votre adresse e-mail d'administrateur ou la valeur de votre identifiant utilisateur unique d'administrateur dans le paramètre de chemin d'accès userKey de l'opération.
Vous trouverez ci-dessous la liste de tous les paramètres de charge utile pouvant être utilisés dans la requête :
| Paramètre | Obligatoire | Type | Description |
|---|---|---|---|
| expire_time | facultatif | chaîne | Heure d'expiration du jeton d'inscription créé, au format "aaaa-MM-jjThh:mm:ssZ". Si ce champ n'est pas spécifié, le jeton d'inscription reste actif jusqu'à ce que les utilisateurs le révoquent. |
| org_unit_path | facultatif | chaîne | Unité organisationnelle pour laquelle créer un jeton d'inscription. Si ce champ n'est pas spécifié, le jeton d'inscription est créé pour l'unité organisationnelle racine. |
| token_type | obligatoire | chaîne | Type d'appareil Chrome pour lequel vous souhaitez créer un jeton d'inscription. Actuellement, seul "CHROME_BROWSER" est accepté. |
| ttl | facultatif | chaîne | Durée de vie du jeton d'inscription créé, encodé en secondes avec le suffixe "s". Par exemple, pour qu'un jeton reste actif pendant une heure, ce champ doit être défini sur "3600s". Si ce champ n'est pas spécifié, le jeton d'inscription reste actif jusqu'à ce que les utilisateurs le révoquent. |
Exemple
Exemple de requête
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",
}
Réponse JSON
Une requête réussie affiche le code d'état HTTP 200. Outre le code d'état, la réponse affiche les propriétés Chrome Enrollment Token :
{
"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",
}
Révoquer un jeton d'inscription
Pour révoquer un jeton d'inscription, utilisez la requête POST suivante et incluez le jeton d'accès obtenu en suivant les instructions de la section "Autorisation".
Remarque : Des retours à la ligne ont été inclus dans cet exemple de code pour le rendre plus lisible.
POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens/{tokenPermanentId}:revoke
- "customerId" est un identifiant unique du compte Google du client.
- Pour emprunter l'identité d'un administrateur de compte, vous pouvez également utiliser la chaîne "my_customer", qui représente l'ID client de votre compte. L'opération de récupération d'un utilisateur permet également d'obtenir la valeur "customerId". Utilisez votre adresse e-mail d'administrateur ou la valeur de votre identifiant utilisateur unique d'administrateur dans le paramètre de chemin d'accès userKey de l'opération.
- "tokenPermanentId" est l'identifiant unique d'un jeton d'inscription. Il se trouve dans le champ "tokenPermanentId" des réponses des opérateurs "List" (Liste) ou "Create" (Créer).
Exemple
Exemple de requête
POST https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens/token_permanent_id_value:revoke
Réponse JSON
Une requête réussie affiche le code d'état HTTP 200.