Skip to content

Administered

Administered

Administered class.

generate_administered_identities_me_api_keys

Generates an API key for an identity.

API documentation: generateAdministeredIdentitiesMeApiKeys

Returns:

  • GenerateAdministeredIdentitiesMeApiKeysResponse

    Successful operation.

Example API response
{
  "key": "1284392014819"
}

get_administered_identities_me

Returns the identity of the current user.

API documentation: getAdministeredIdentitiesMe

Returns:

  • GetAdministeredIdentitiesMeResponse

    Successful operation.

Example API response
{
  "name": "Miles Meraki",
  "email": "miles@meraki.com",
  "lastUsedDashboardAt": "2018-02-11T00:00:00.090210Z",
  "authentication": {
    "mode": "email",
    "api": {
      "key": {
        "created": true
      }
    },
    "twoFactor": {
      "enabled": false
    },
    "saml": {
      "enabled": false
    }
  }
}

get_administered_identities_me_api_keys

List the non-sensitive metadata associated with the API keys that belong to the user.

API documentation: getAdministeredIdentitiesMeApiKeys

Returns:

  • PaginatedResponse[GetAdministeredIdentitiesMeApiKeysResponseItem]

    Successful operation.

Note

Returns a lazy PaginatedResponse that can be iterated or collected with .collect(). Page metadata is available on .meta and .meta_pages.

Example API response
[
  {
    "suffix": "da4f",
    "createdAt": "2018-02-11T00:00:00.090210Z"
  }
]

revoke_administered_identities_me_api_keys

Revokes an identity's API key, using the last four characters of the key.

API documentation: revokeAdministeredIdentitiesMeApiKeys

Parameters:

  • suffix (str) –

    Suffix.

Returns:

  • None

    Successful operation.