Skip to content

Latest commit

 

History

History
173 lines (124 loc) · 6.55 KB

AuthzApi.md

File metadata and controls

173 lines (124 loc) · 6.55 KB
Raw

greenlake_data_services.AuthzApi

All URIs are relative to https://eu1.data.cloud.hpe.com

Method HTTP request Description
get_access_controls GET /api/v1/access-controls Get User Accessible Resources
get_resource_types GET /api/v1/resource-types Get resource types with read permissions

get_access_controls

AccessControlsResponse get_access_controls()

Get User Accessible Resources

Retun a list of user permissions. The returned list of permissions will be based upon the supplied filter. If no filter was supplied, all user permissions will be returned. It is also possible to request all resource type with certain permission type (ex. ALL.read)

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import authz_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.access_controls_response import AccessControlsResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authz_api.AuthzApi(api_client)
    permission = ["volume.create","port.read","audit.read"] # [str] | List of permissions, each of which, has the form \"resource type.permission\" (ex. volume.read,volume.write). The word \"ANY\" can be used as a wild card for the resource type (ex. ANY.read). Omitting the permission parameters is equivalent to asking for all user permissions. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get User Accessible Resources
        api_response = api_instance.get_access_controls(permission=permission)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling AuthzApi->get_access_controls: %s\n" % e)

Parameters

Name Type Description Notes
permission [str] List of permissions, each of which, has the form "resource type.permission" (ex. volume.read,volume.write). The word "ANY" can be used as a wild card for the resource type (ex. ANY.read). Omitting the permission parameters is equivalent to asking for all user permissions. [optional]

Return type

AccessControlsResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
401 The operation cannot be authorized -
403 The operation is forbidden -
404 User not found -
429 Too Many Requests -
503 Service Unavailable -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_resource_types

ResourceTypesResponse get_resource_types()

Get resource types with read permissions

Return resource types on which the user has a read permission. The returned list will be based upon the supplied filter. If no filter was provided, all resource types for which the user has a read permission on will be returned

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import authz_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.resource_types_response import ResourceTypesResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# 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 Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authz_api.AuthzApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Get resource types with read permissions
        api_response = api_instance.get_resource_types()
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling AuthzApi->get_resource_types: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ResourceTypesResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
401 The operation cannot be authorized -
403 The operation is forbidden -
404 User not found -
429 Too Many Requests -
503 Service Unavailable -

[Back to top] [Back to API list] [Back to Model list] [Back to README]