Använd Chrome Browser Enrollment Token API

Auktorisering

Auktorisering som krävs för åtkomst till Enrollment Token API beskrivs i Chrome Enterprise Core's Takeout API Service Script-guiden. Användarna måste följa samma steg för att hämta en åtkomsttoken.

ChromeRegistreringstoken

ChromeEnrollmentToken är en sträng som används för att identifiera registrering av en Chrome-webbläsare.

Resursrepresentation

Följande JSON-mall används för ChromeEnrollmentToken-resursen i Directory API:

{

"kind": "admin#directory#chromeEnrollmentToken",

"orgUnitPath": string,

"token": string,

"tokenPermanentId": string,

"customerId": string,

"orgUnitPath": string,

"state": enum {
    "active",

    "expired",

    "revoked",

}

"expiration": oneof {

    "expireTime": dateTime,

    "ttl": duration

  }

"creatorId": string,

"creationTime": dateTime,

"revokerId": string,

"revokeTime": dateTime,

"tokenType": enum {

    "chromeBrowser"

  }

}

Anropa API

Lista alla registreringstoken för ett konto

Om du vill lista alla Chrome-registreringstoken för ett konto på en organisationsenhet använder du följande GET-begäran och inkluderar den åtkomsttoken som hämtas genom att följa avsnittet Auktorisering. 

Obs! Kodexemplet innehåller radreturer för att det ska bli lättare att läsa.

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}

  • Kund-id är en unik identifierare för kundens Google-konto.
  • När du utger dig för att vara kontoadministratör kan du även använda strängen my_customer som representerar kundens id för kontot. Ett annat sätt att få värdet för kund-id är att använda åtgärden Hämta en användare. Använd administratörens e-postadress eller ditt unika administratörs-id i åtgärdens userKey-parameter.

Följande parametrar kan användas i begäran:

Parameter Obligatoriskt Typ Beskrivning
orgUnitPath valfritt string Ange endast registreringstoken som har skapats för en viss organisationsenhet.  Om det här fältet lämnas tomt listas alla registreringstoken för den här kunden.
pageSize valfritt int Maximalt antal resultat att returnera. Maxvärde och standard är 100.
pageToken valfritt string Sökparametern pageToken används för att begära nästa sida med sökresultat. Sökparametern pageTokens uppföljningsbegäran är nästaPageToken från ditt tidigare svar. Obs! Begäranden med fältet page_token måste ha samma fältvärde för sökning och org_unit_path som begäran som genererade page_token.
query valfritt string Söksträng för att filtrera angivna token. Formatet för listsidans frågespråk beskrivs i avsnittet nedan (Filtrera frågespråk).

Exempel

En exempelbegäran

GET https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens?pageSize=1&orgUnitPath=”/Org-unit-path”

JSON-svar

En lyckad begäran returnerar statuskoden HTTP 200. Tillsammans med statuskoden returnerar svaret egenskaperna för Chrome-registreringstoken:

{
  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"
}

Språk i filtersökfråga

När du använder parametern ”query” i en listbegäran måste varje term i sökfrågan matchas i en av följande parametrar för att resultaten ska betraktas som en matchning. Du kan ange att de returnerade token ska begränsas så att de matchar fältvärdet för termen. Om du inte anger några operatorer (fält) i sökfrågan hittar sökningen alla registreringstoken.

Om din sökfråga exempelvis är:
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED",
returnerar detta registreringstoken som följande:

{
  "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",
}

Du kan ange följande fält om du vill rikta in sökningen på ett visst fält:

Fält Beskrivning
device_type Den enhetstyp som registreringstoken används för. För närvarande stöds endast CHROME_BROWSER.
token_state Status för en registreringstoken. Värden som stöds är: REVOKED, ACTIVE, EXPIRED.

Skapa en registreringstoken

Om du vill skapa en Chrome-registreringstoken på en organisationsenhet använder du följande POST-begäran och inkluderar den åtkomsttoken som erhålls genom att följa avsnittet Auktorisering.

Obs! Kodexemplet innehåller radreturer för att det ska bli lättare att läsa.

POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens

  • Kund-id är en unik identifierare för kundens Google-konto.
  • När du utger dig för att vara kontoadministratör kan du även använda strängen my_customer som representerar kundens id för kontot. Ett annat sätt att få värdet för kund-id är att använda åtgärden Hämta en användare. Använd administratörens e-postadress eller ditt unika administratörs-id i åtgärdens userKey-parameter.

Följande parametrar kan användas i begäran:

Parameter Obligatoriskt Typ Beskrivning
expire_time valfritt string Sista giltighetstid för skapad registreringstoken i formatet "åååå-MM-ddThh:mm:ssZ". Om fältet inte anges gäller registreringstoken tills användaren återkallar den.
org_unit_path valfritt string Organisationsenheten att skapa en registreringstoken för. Om det här fältet inte anges skapas registreringstoken för rotorganisationsenheten.
token_type obligatoriskt string Typ av Chrome-enhet att skapa registreringstoken för. För närvarande stöds endast CHROME_BROWSER.
ttl valfritt string Livslängd för skapad registreringstoken, kodad i sekunder med suffixet ”s”. Om en token ska användas i en timme ska det här fältet till exempel ställas in på ”3600s”. Om fältet inte har ställts in gäller registreringstoken tills användaren återkallar den.

Exempel

En exempelbegäran

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-svar

En lyckad begäran returnerar statuskoden HTTP 200. Tillsammans med statuskoden returnerar svaret egenskaperna för Chrome-registreringstoken:

{
  "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",
}

Återkalla en registreringstoken

Om du vill återkalla en registreringstoken använder du följande POST-begäran och inkluderar den åtkomsttoken som erhålls genom att följa avsnittet Auktorisering. 

Obs! Kodexemplet innehåller radreturer för att det ska bli lättare att läsa.

POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens/{tokenPermanentId}:revoke

  • Kund-id är en unik identifierare för kundens Google-konto.
  • När du utger dig för att vara kontoadministratör kan du även använda strängen my_customer som representerar kundens id för kontot. Ett annat sätt att få värdet för kund-id är att använda åtgärden Hämta en användare. Använd administratörens e-postadress eller ditt unika administratörs-id i åtgärdens userKey-parameter.
  • TokenPermanentId är en unik identifierare för en registreringstoken och finns i fältet tokenPermanentId i svaren för Lista eller Skapa.

Exempel

En exempelbegäran

POST https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens/token_permanent_id_value:revoke

JSON-svar

En lyckad begäran returnerar statuskoden HTTP 200.

Var det här till hjälp?

Hur kan vi förbättra den?
Sök
Rensa sökning
Stäng sökrutan
Huvudmeny
3718252605617872375
true
Sök i hjälpcentret
true
true
true
true
true
410864
false
false