stepup_auth_level¶

The following methods allow for interaction with the ZPA Step Up Auth Level API endpoints.

Methods are accessible via zpa.stepup_auth_level

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class StepUpAuthLevelAPI¶

Bases: APIClient

A Client object for the Step Up Auth Level resource.

get_step_up_auth_levels(query_params=None)¶

Get step up authentication levels.

This endpoint retrieves a list of step up authentication levels configured for the customer. Step up authentication levels define the authentication requirements for users based on risk factors.

Keyword Arguments:

{dict} (query_params) –

Map of query parameters for the request.

[query_params.microtenant_id] {str}: The unique identifier of the microtenant of ZPA tenant.

Returns:

A tuple containing (list of StepUpAuthLevel instances, Response, error).

Return type:

Tuple

Examples

List all step up authentication levels:

>>> auth_levels, _, err = client.zpa.stepup_auth_level.get_step_up_auth_levels()
... if err:
...     print(f"Error getting step up auth levels: {err}")
...     return
... print(f"Total step up auth levels found: {len(auth_levels)}")
... for level in auth_levels:
...     print(level.as_dict())

List step up authentication levels with microtenant ID:

>>> auth_levels, _, err = client.zpa.stepup_auth_level.get_step_up_auth_levels(
...     query_params={'microtenant_id': '1234567890'}
... )
... if err:
...     print(f"Error getting step up auth levels: {err}")
...     return
... print(f"Total step up auth levels found: {len(auth_levels)}")
... for level in auth_levels:
...     print(f"Name: {level.name}, Delta: {level.delta}, Description: {level.description}")