Chrome Management API . customers . enrollmentTokens

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, enrollmentTokenId=None, x__xgafv=None)

Creates a new enrollment token for a browser device. Creation fails if there is already an active token for this customer under the same org unit.

get(name, x__xgafv=None)

Gets a browser device enrollment token.

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists all browser device enrollment tokens.

list_next(previous_request, previous_response)

Retrieves the next page of results.

revoke(name, body=None, x__xgafv=None)

Revokes a browser device enrollment token.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, enrollmentTokenId=None, x__xgafv=None)
Creates a new enrollment token for a browser device. Creation fails if there is already an active token for this customer under the same org unit.

Args:
  parent: string, Required. The parent resource where this enrollment token will be created. Format: customers/{customer} (required)
  body: object, The request body.
    The object takes the form of:

{ # Enrollment token for a chrome device.
  "createTime": "A String", # Output only. The creation time of the token.
  "creatorId": "A String", # Output only. The id of the user who created the token.
  "customerId": "A String", # Output only. The obfuscated ID of the customer to whom this token is associated.
  "name": "A String", # Identifier. The resource name of the enrollment token. Format: customers/{customer}/enrollmentTokens/{token_permanent_id}
  "orgUnitId": "A String", # Optional. Obfuscated ID of the organization unit this token is associated with. If not set, the token is created for the root organization unit.
  "revokeTime": "A String", # Output only. The revocation time of the token, null if the token is not revoked.
  "revokerId": "A String", # Output only. The id of the user who revoked the token, null if the token is not revoked.
  "state": "A String", # Output only. The state of the token.
  "token": "A String", # Output only. The value of the token stored on the device and used to identify it to the management service handling the enrollment request.
  "tokenPermanentId": "A String", # Output only. Unique identifier of the enrollment token used to access information on tokens.
  "tokenType": "A String", # Optional. The device type this token is used for. If not set, defaults to `ENROLLMENT_TOKEN_TYPE_CHROME_BROWSER`.
}

  enrollmentTokenId: string, Optional. The ID to use for the enrollment token, which will become the final component of the enrollment token's resource name. This value must be local-unique under the customer and is optional. If not provided, it will be auto-generated. If provided, it must be 1-63 characters long and match the regular expression `[a-zA-Z0-9._-]+`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Enrollment token for a chrome device.
  "createTime": "A String", # Output only. The creation time of the token.
  "creatorId": "A String", # Output only. The id of the user who created the token.
  "customerId": "A String", # Output only. The obfuscated ID of the customer to whom this token is associated.
  "name": "A String", # Identifier. The resource name of the enrollment token. Format: customers/{customer}/enrollmentTokens/{token_permanent_id}
  "orgUnitId": "A String", # Optional. Obfuscated ID of the organization unit this token is associated with. If not set, the token is created for the root organization unit.
  "revokeTime": "A String", # Output only. The revocation time of the token, null if the token is not revoked.
  "revokerId": "A String", # Output only. The id of the user who revoked the token, null if the token is not revoked.
  "state": "A String", # Output only. The state of the token.
  "token": "A String", # Output only. The value of the token stored on the device and used to identify it to the management service handling the enrollment request.
  "tokenPermanentId": "A String", # Output only. Unique identifier of the enrollment token used to access information on tokens.
  "tokenType": "A String", # Optional. The device type this token is used for. If not set, defaults to `ENROLLMENT_TOKEN_TYPE_CHROME_BROWSER`.
}
get(name, x__xgafv=None)
Gets a browser device enrollment token.

Args:
  name: string, Required. The name of the enrollment token to retrieve. Format: customers/{customer}/enrollmentTokens/{token_permanent_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Enrollment token for a chrome device.
  "createTime": "A String", # Output only. The creation time of the token.
  "creatorId": "A String", # Output only. The id of the user who created the token.
  "customerId": "A String", # Output only. The obfuscated ID of the customer to whom this token is associated.
  "name": "A String", # Identifier. The resource name of the enrollment token. Format: customers/{customer}/enrollmentTokens/{token_permanent_id}
  "orgUnitId": "A String", # Optional. Obfuscated ID of the organization unit this token is associated with. If not set, the token is created for the root organization unit.
  "revokeTime": "A String", # Output only. The revocation time of the token, null if the token is not revoked.
  "revokerId": "A String", # Output only. The id of the user who revoked the token, null if the token is not revoked.
  "state": "A String", # Output only. The state of the token.
  "token": "A String", # Output only. The value of the token stored on the device and used to identify it to the management service handling the enrollment request.
  "tokenPermanentId": "A String", # Output only. Unique identifier of the enrollment token used to access information on tokens.
  "tokenType": "A String", # Optional. The device type this token is used for. If not set, defaults to `ENROLLMENT_TOKEN_TYPE_CHROME_BROWSER`.
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all browser device enrollment tokens.

Args:
  parent: string, Required. The parent resource where this enrollment token will be created. Format: customers/{customer} (required)
  filter: string, Optional. Filter to apply to list results. The following fields can be used in the filter: * device_type (currently only 'CHROME_BROWSER' is supported) * token_state (supported values: 'ACTIVE', 'EXPIRED', 'REVOKED') * org_unit_path The full path of the org unit, such as /Montreal/Sales. * org_unit_id The obfuscated id of the org unit, not the full path.
  pageSize: integer, Optional. Maximum number of results to return. Maximum and default are 100.
  pageToken: string, Optional. Token to specify next page in the list.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response that contains a list of tokens.
  "enrollmentTokens": [ # List of Chrome device enrollment tokens.
    { # Enrollment token for a chrome device.
      "createTime": "A String", # Output only. The creation time of the token.
      "creatorId": "A String", # Output only. The id of the user who created the token.
      "customerId": "A String", # Output only. The obfuscated ID of the customer to whom this token is associated.
      "name": "A String", # Identifier. The resource name of the enrollment token. Format: customers/{customer}/enrollmentTokens/{token_permanent_id}
      "orgUnitId": "A String", # Optional. Obfuscated ID of the organization unit this token is associated with. If not set, the token is created for the root organization unit.
      "revokeTime": "A String", # Output only. The revocation time of the token, null if the token is not revoked.
      "revokerId": "A String", # Output only. The id of the user who revoked the token, null if the token is not revoked.
      "state": "A String", # Output only. The state of the token.
      "token": "A String", # Output only. The value of the token stored on the device and used to identify it to the management service handling the enrollment request.
      "tokenPermanentId": "A String", # Output only. Unique identifier of the enrollment token used to access information on tokens.
      "tokenType": "A String", # Optional. The device type this token is used for. If not set, defaults to `ENROLLMENT_TOKEN_TYPE_CHROME_BROWSER`.
    },
  ],
  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
revoke(name, body=None, x__xgafv=None)
Revokes a browser device enrollment token.

Args:
  name: string, Required. The name of the enrollment token to revoke. Format: customers/{customer}/enrollmentTokens/{token_permanent_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request to revoke a token.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Enrollment token for a chrome device.
  "createTime": "A String", # Output only. The creation time of the token.
  "creatorId": "A String", # Output only. The id of the user who created the token.
  "customerId": "A String", # Output only. The obfuscated ID of the customer to whom this token is associated.
  "name": "A String", # Identifier. The resource name of the enrollment token. Format: customers/{customer}/enrollmentTokens/{token_permanent_id}
  "orgUnitId": "A String", # Optional. Obfuscated ID of the organization unit this token is associated with. If not set, the token is created for the root organization unit.
  "revokeTime": "A String", # Output only. The revocation time of the token, null if the token is not revoked.
  "revokerId": "A String", # Output only. The id of the user who revoked the token, null if the token is not revoked.
  "state": "A String", # Output only. The state of the token.
  "token": "A String", # Output only. The value of the token stored on the device and used to identify it to the management service handling the enrollment request.
  "tokenPermanentId": "A String", # Output only. Unique identifier of the enrollment token used to access information on tokens.
  "tokenType": "A String", # Optional. The device type this token is used for. If not set, defaults to `ENROLLMENT_TOKEN_TYPE_CHROME_BROWSER`.
}