ApiKey Schema

Data structure for Api Key objects.

Fields

Field	Type	Required	Description	Notes
`id`	long	No	-	-
`modified_time`	integer	No	-	API field: `modified_time`
`creation_time`	integer	No	-	API field: `creation_time`
`modified_by`	long	No	-	API field: `modified_by`
`name`	string	Yes	-	-
`microtenant_id`	long	No	-	API field: `microtenant_id`
`microtenant_name`	string	No	-	API field: `microtenant_name`
`restriction_type`	string	No	-	API field: `restriction_type`
`client_id`	string	No	-	API field: `client_id`
`client_secret`	string	No	-	API field: `client_secret`
`enabled`	boolean	No	-	-
`token_expiry_time_in_sec`	integer	No	-	API field: `token_expiry_time_in_sec`
`role_id`	long	No	-	API field: `role_id`
`pin_session_enabled`	boolean	No	-	API field: `pin_session_enabled`
`is_locked`	boolean	No	-	API field: `is_locked`
`sync_version`	long	No	-	API field: `sync_version`
`iam_client_id`	string	No	-	API field: `iam_client_id`
`read_only`	boolean	No	-	API field: `read_only`
`zscaler_managed`	boolean	No	-	API field: `zscaler_managed`
`name_without_trim`	string	No	-	API field: `name_without_trim`

Example

{
  "id": 123,
  "modified_time": 123,
  "creation_time": 123,
  "modified_by": 123,
  "name": "string",
  "microtenant_id": 123,
  "microtenant_name": "string",
  "restriction_type": "string"
}
// ... more fields

Fields​

Example​

Fields

Example