All URIs are relative to https://demo.ziti.dev/edge/management/v1
| Method | HTTP request | Description |
|---|---|---|
| associate_identitys_service_configs | POST /identities/{id}/service-configs | Associate service configs for a specific identity |
| create_identity | POST /identities | Create an identity resource |
| delete_identity | DELETE /identities/{id} | Delete an identity |
| detail_identity | GET /identities/{id} | Retrieves a single identity |
| detail_identity_type | GET /identity-types/{id} | Retrieves a identity type |
| disable_identity | POST /identities/{id}/disable | Set an identity as disabled |
| disassociate_identitys_service_configs | DELETE /identities/{id}/service-configs | Remove associated service configs from a specific identity |
| enable_identity | POST /identities/{id}/enable | Clears all disabled state from an identity |
| get_identity_authenticators | GET /identities/{id}/authenticators | Retrieve the current authenticators of a specific identity |
| get_identity_enrollments | GET /identities/{id}/enrollments | Retrieve the current enrollments of a specific identity |
| get_identity_failed_service_requests | GET /identities/{id}/failed-service-requests | Retrieve a list of the most recent service failure requests due to posture checks |
| get_identity_policy_advice | GET /identities/{id}/policy-advice/{serviceId} | Analyze policies relating the given identity and service |
| get_identity_posture_data | GET /identities/{id}/posture-data | Retrieve the curent posture data for a specific identity. |
| list_identities | GET /identities | List identities |
| list_identity_edge_routers | GET /identities/{id}/edge-routers | List accessible edge-routers |
| list_identity_service_policies | GET /identities/{id}/service-policies | List the service policies that affect an identity |
| list_identity_services | GET /identities/{id}/services | List accessible services |
| list_identity_types | GET /identity-types | List available identity types |
| list_identitys_edge_router_policies | GET /identities/{id}/edge-router-policies | List the edge router policies that affect an identity |
| list_identitys_service_configs | GET /identities/{id}/service-configs | List the service configs associated a specific identity |
| patch_identity | PATCH /identities/{id} | Update the supplied fields on an identity |
| remove_identity_mfa | DELETE /identities/{id}/mfa | Remove MFA from an identitity |
| update_identity | PUT /identities/{id} | Update all fields on an identity |
| update_identity_tracing | PUT /identities/{id}/trace | Enable/disable data flow tracing for an identity |
Empty associate_identitys_service_configs(id, service_configs)
Associate service configs for a specific identity
Associate service configs to a specific identity
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.service_configs_assign_list import ServiceConfigsAssignList
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.empty import Empty
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
service_configs = ServiceConfigsAssignList([
ServiceConfigAssign(
config_id="config_id_example",
service_id="service_id_example",
),
]) # ServiceConfigsAssignList | A service config patch object
# example passing only required values which don't have defaults set
try:
# Associate service configs for a specific identity
api_response = api_instance.associate_identitys_service_configs(id, service_configs)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->associate_identitys_service_configs: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource | |
| service_configs | ServiceConfigsAssignList | A service config patch object |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Base empty response | - |
| 400 | The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateEnvelope create_identity(identity)
Create an identity resource
Create an identity resource. Requires admin access.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.create_envelope import CreateEnvelope
from openziti_edge_management.model.identity_create import IdentityCreate
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
identity = IdentityCreate(
app_data=Tags(None),
auth_policy_id="auth_policy_id_example",
default_hosting_cost=TerminatorCost(0),
default_hosting_precedence=TerminatorPrecedence("default"),
enrollment=IdentityCreateEnrollment(
ott=True,
ottca="ottca_example",
updb="updb_example",
),
external_id="external_id_example",
is_admin=True,
name="name_example",
role_attributes=Attributes([
"role_attributes_example",
]),
service_hosting_costs=TerminatorCostMap(
key=TerminatorCost(0),
),
service_hosting_precedences=TerminatorPrecedenceMap(
key=TerminatorPrecedence("default"),
),
tags=Tags(None),
type=IdentityType("User"),
) # IdentityCreate | An identity to create
# example passing only required values which don't have defaults set
try:
# Create an identity resource
api_response = api_instance.create_identity(identity)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->create_identity: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| identity | IdentityCreate | An identity to create |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | The create request was successful and the resource has been added at the following location | - |
| 400 | The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty delete_identity(id)
Delete an identity
Delete an identity by id. Requires admin access.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.empty import Empty
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# Delete an identity
api_response = api_instance.delete_identity(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->delete_identity: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The delete request was successful and the resource has been removed | - |
| 400 | The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 409 | The resource requested to be removed/altered cannot be as it is referenced by another object. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DetailIdentityEnvelope detail_identity(id)
Retrieves a single identity
Retrieves a single identity by id. Requires admin access.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.detail_identity_envelope import DetailIdentityEnvelope
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# Retrieves a single identity
api_response = api_instance.detail_identity(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->detail_identity: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A single identity | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DetailIdentityTypeEnvelope detail_identity_type(id)
Retrieves a identity type
Retrieves a single identity type by id. Requires admin access.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.detail_identity_type_envelope import DetailIdentityTypeEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# Retrieves a identity type
api_response = api_instance.detail_identity_type(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->detail_identity_type: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A single identity type | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty disable_identity(id, disable)
Set an identity as disabled
Allows an admin disable an identity for a set amount of time or indefinitely.
- Api Key Authentication (ztSession):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.disable_params import DisableParams
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.empty import Empty
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
disable = DisableParams(
duration_minutes=1,
) # DisableParams | Disable parameters
# example passing only required values which don't have defaults set
try:
# Set an identity as disabled
api_response = api_instance.disable_identity(id, disable)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->disable_identity: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource | |
| disable | DisableParams | Disable parameters |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Base empty response | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty disassociate_identitys_service_configs(id)
Remove associated service configs from a specific identity
Remove service configs from a specific identity
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.service_configs_assign_list import ServiceConfigsAssignList
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.empty import Empty
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
service_config_id_pairs = ServiceConfigsAssignList([
ServiceConfigAssign(
config_id="config_id_example",
service_id="service_id_example",
),
]) # ServiceConfigsAssignList | An array of service and config id pairs to remove (optional)
# example passing only required values which don't have defaults set
try:
# Remove associated service configs from a specific identity
api_response = api_instance.disassociate_identitys_service_configs(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->disassociate_identitys_service_configs: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Remove associated service configs from a specific identity
api_response = api_instance.disassociate_identitys_service_configs(id, service_config_id_pairs=service_config_id_pairs)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->disassociate_identitys_service_configs: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource | |
| service_config_id_pairs | ServiceConfigsAssignList | An array of service and config id pairs to remove | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Base empty response | - |
| 400 | The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty enable_identity(id)
Clears all disabled state from an identity
Allows an admin to remove disabled statuses from an identity.
- Api Key Authentication (ztSession):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.empty import Empty
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# Clears all disabled state from an identity
api_response = api_instance.enable_identity(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->enable_identity: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Base empty response | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListAuthenticatorsEnvelope get_identity_authenticators(id)
Retrieve the current authenticators of a specific identity
Returns a list of authenticators associated to the identity specified
- Api Key Authentication (ztSession):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.list_authenticators_envelope import ListAuthenticatorsEnvelope
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# Retrieve the current authenticators of a specific identity
api_response = api_instance.get_identity_authenticators(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->get_identity_authenticators: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A list of authenticators | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListEnrollmentsEnvelope get_identity_enrollments(id)
Retrieve the current enrollments of a specific identity
Returns a list of enrollments associated to the identity specified
- Api Key Authentication (ztSession):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.list_enrollments_envelope import ListEnrollmentsEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# Retrieve the current enrollments of a specific identity
api_response = api_instance.get_identity_enrollments(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->get_identity_enrollments: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A list of enrollments | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FailedServiceRequestEnvelope get_identity_failed_service_requests(id)
Retrieve a list of the most recent service failure requests due to posture checks
Returns a list of service session requests that failed due to posture checks. The entries will contain every policy that was verified against and every failed check in each policy. Each check will include the historical posture data and posture check configuration.
- Api Key Authentication (ztSession):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.failed_service_request_envelope import FailedServiceRequestEnvelope
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# Retrieve a list of the most recent service failure requests due to posture checks
api_response = api_instance.get_identity_failed_service_requests(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->get_identity_failed_service_requests: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns a list of service request failures | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetIdentityPolicyAdviceEnvelope get_identity_policy_advice(id, service_id)
Analyze policies relating the given identity and service
Analyzes policies to see if the given identity should be able to dial or bind the given service. | Will check services policies to see if the identity can access the service. Will check edge router policies | to check if the identity and service have access to common edge routers so that a connnection can be made. | Will also check if at least one edge router is on-line. Requires admin access.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.get_identity_policy_advice_envelope import GetIdentityPolicyAdviceEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
service_id = "serviceId_example" # str | The id of a service
# example passing only required values which don't have defaults set
try:
# Analyze policies relating the given identity and service
api_response = api_instance.get_identity_policy_advice(id, service_id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->get_identity_policy_advice: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource | |
| service_id | str | The id of a service |
GetIdentityPolicyAdviceEnvelope
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns the document that represents the policy advice | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostureDataEnvelope get_identity_posture_data(id)
Retrieve the curent posture data for a specific identity.
Returns a nested map data represeting the posture data of the identity. This data should be considered volatile.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.posture_data_envelope import PostureDataEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# Retrieve the curent posture data for a specific identity.
api_response = api_instance.get_identity_posture_data(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->get_identity_posture_data: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns the document that represents posture data | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListIdentitiesEnvelope list_identities()
List identities
Retrieves a list of identity resources; supports filtering, sorting, and pagination. Requires admin access.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.list_identities_envelope import ListIdentitiesEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
limit = 1 # int | (optional)
offset = 1 # int | (optional)
filter = "filter_example" # str | (optional)
role_filter = [
"roleFilter_example",
] # [str] | (optional)
role_semantic = "roleSemantic_example" # str | (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# List identities
api_response = api_instance.list_identities(limit=limit, offset=offset, filter=filter, role_filter=role_filter, role_semantic=role_semantic)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->list_identities: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| limit | int | [optional] | |
| offset | int | [optional] | |
| filter | str | [optional] | |
| role_filter | [str] | [optional] | |
| role_semantic | str | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A list of identities | - |
| 400 | The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListEdgeRoutersEnvelope list_identity_edge_routers(id)
List accessible edge-routers
Retrieves a list of edge-routers that the given identity may use to access services. Supports filtering, sorting, and pagination. Requires admin access.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.list_edge_routers_envelope import ListEdgeRoutersEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# List accessible edge-routers
api_response = api_instance.list_identity_edge_routers(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->list_identity_edge_routers: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A list of edge routers | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListServicePoliciesEnvelope list_identity_service_policies(id)
List the service policies that affect an identity
Retrieves a list of service policies that apply to the specified identity.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.list_service_policies_envelope import ListServicePoliciesEnvelope
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# List the service policies that affect an identity
api_response = api_instance.list_identity_service_policies(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->list_identity_service_policies: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A list of service policies | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListEdgeRoutersEnvelope list_identity_services(id)
List accessible services
Retrieves a list of services that the given identity has access to. Supports filtering, sorting, and pagination. Requires admin access.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.list_edge_routers_envelope import ListEdgeRoutersEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# List accessible services
api_response = api_instance.list_identity_services(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->list_identity_services: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A list of edge routers | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListIdentityTypesEnvelope list_identity_types()
List available identity types
Retrieves a list of identity types; supports filtering, sorting, and pagination. Requires admin access.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.list_identity_types_envelope import ListIdentityTypesEnvelope
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
limit = 1 # int | (optional)
offset = 1 # int | (optional)
filter = "filter_example" # str | (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# List available identity types
api_response = api_instance.list_identity_types(limit=limit, offset=offset, filter=filter)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->list_identity_types: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| limit | int | [optional] | |
| offset | int | [optional] | |
| filter | str | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A list of identity types | - |
| 400 | The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListEdgeRouterPoliciesEnvelope list_identitys_edge_router_policies(id)
List the edge router policies that affect an identity
Retrieves a list of edge router policies that apply to the specified identity.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.list_edge_router_policies_envelope import ListEdgeRouterPoliciesEnvelope
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# List the edge router policies that affect an identity
api_response = api_instance.list_identitys_edge_router_policies(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->list_identitys_edge_router_policies: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
ListEdgeRouterPoliciesEnvelope
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A list of edge router policies | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListServiceConfigsEnvelope list_identitys_service_configs(id)
List the service configs associated a specific identity
Retrieves a list of service configs associated to a specific identity
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.list_service_configs_envelope import ListServiceConfigsEnvelope
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# List the service configs associated a specific identity
api_response = api_instance.list_identitys_service_configs(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->list_identitys_service_configs: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A list of service configs | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty patch_identity(id, identity)
Update the supplied fields on an identity
Update the supplied fields on an identity. Requires admin access.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.identity_patch import IdentityPatch
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.empty import Empty
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
identity = IdentityPatch(
app_data=Tags(None),
auth_policy_id="auth_policy_id_example",
default_hosting_cost=TerminatorCost(0),
default_hosting_precedence=TerminatorPrecedence("default"),
external_id="external_id_example",
is_admin=True,
name="name_example",
role_attributes=Attributes([
"role_attributes_example",
]),
service_hosting_costs=TerminatorCostMap(
key=TerminatorCost(0),
),
service_hosting_precedences=TerminatorPrecedenceMap(
key=TerminatorPrecedence("default"),
),
tags=Tags(None),
type=IdentityType("User"),
) # IdentityPatch | An identity patch object
# example passing only required values which don't have defaults set
try:
# Update the supplied fields on an identity
api_response = api_instance.patch_identity(id, identity)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->patch_identity: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource | |
| identity | IdentityPatch | An identity patch object |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The patch request was successful and the resource has been altered | - |
| 400 | The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty remove_identity_mfa(id)
Remove MFA from an identitity
Allows an admin to remove MFA enrollment from a specific identity. Requires admin.
- Api Key Authentication (ztSession):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.empty import Empty
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
# example passing only required values which don't have defaults set
try:
# Remove MFA from an identitity
api_response = api_instance.remove_identity_mfa(id)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->remove_identity_mfa: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Base empty response | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty update_identity(id, identity)
Update all fields on an identity
Update all fields on an identity by id. Requires admin access.
- Api Key Authentication (ztSession):
- OAuth Authentication (oauth2):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_management.model.identity_update import IdentityUpdate
from openziti_edge_management.model.empty import Empty
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
identity = IdentityUpdate(
app_data=Tags(None),
auth_policy_id="auth_policy_id_example",
default_hosting_cost=TerminatorCost(0),
default_hosting_precedence=TerminatorPrecedence("default"),
external_id="external_id_example",
is_admin=True,
name="name_example",
role_attributes=Attributes([
"role_attributes_example",
]),
service_hosting_costs=TerminatorCostMap(
key=TerminatorCost(0),
),
service_hosting_precedences=TerminatorPrecedenceMap(
key=TerminatorPrecedence("default"),
),
tags=Tags(None),
type=IdentityType("User"),
) # IdentityUpdate | An identity update object
# example passing only required values which don't have defaults set
try:
# Update all fields on an identity
api_response = api_instance.update_identity(id, identity)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->update_identity: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource | |
| identity | IdentityUpdate | An identity update object |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The update request was successful and the resource has been altered | - |
| 400 | The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TraceDetailEnvelope update_identity_tracing(id, trace_spec)
Enable/disable data flow tracing for an identity
Allows an admin to enable/disable data flow tracing for an identity
- Api Key Authentication (ztSession):
import time
import openziti_edge_management
from openziti_edge_management.api import identity_api
from openziti_edge_management.model.trace_detail_envelope import TraceDetailEnvelope
from openziti_edge_management.model.trace_spec import TraceSpec
from openziti_edge_management.model.api_error_envelope import ApiErrorEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/management/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_management.Configuration(
host = "https://demo.ziti.dev/edge/management/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'
# Enter a context with an instance of the API client
with openziti_edge_management.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = identity_api.IdentityApi(api_client)
id = "id_example" # str | The id of the requested resource
trace_spec = TraceSpec(
channels=[
"channels_example",
],
duration="duration_example",
enabled=True,
trace_id="trace_id_example",
) # TraceSpec | A traceSpec object
# example passing only required values which don't have defaults set
try:
# Enable/disable data flow tracing for an identity
api_response = api_instance.update_identity_tracing(id, trace_spec)
pprint(api_response)
except openziti_edge_management.ApiException as e:
print("Exception when calling IdentityApi->update_identity_tracing: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the requested resource | |
| trace_spec | TraceSpec | A traceSpec object |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns the document that represents the trace state | - |
| 400 | The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information | - |
| 401 | The currently supplied session does not have the correct access rights to request this resource | - |
| 404 | The requested resource does not exist | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]