Skip to content

Latest commit

 

History

History
230 lines (167 loc) · 8.75 KB

SAMLProviderRulesApi.md

File metadata and controls

230 lines (167 loc) · 8.75 KB

cloudcheckr_cmx_client.SAMLProviderRulesApi

All URIs are relative to //api-us.cloudcheckr.com/

Method HTTP request Description
create_saml_provider_rule POST /auth/v1/customers/{customerId}/saml-providers/{samlProviderId}/rules Creates a new SAML provider rule for the specified SAML provider.
delete_saml_provider_rule DELETE /auth/v1/customers/{customerId}/saml-providers/{samlProviderId}/rules/{ruleId} Deletes a SAML provider rule.
list_saml_provider_rules GET /auth/v1/customers/{customerId}/saml-providers/{samlProviderId}/rules Get all SAML provider rules assigned to a SAML provider.
update_saml_provider_rule PUT /auth/v1/customers/{customerId}/saml-providers/{samlProviderId}/rules/{ruleId} Updates a SAML provider rule.

create_saml_provider_rule

SamlProviderRuleResponseModel create_saml_provider_rule(customer_id, saml_provider_id, body=body)

Creates a new SAML provider rule for the specified SAML provider.

Example

from __future__ import print_function
import time
import cloudcheckr_cmx_client
from cloudcheckr_cmx_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = cloudcheckr_cmx_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = cloudcheckr_cmx_client.SAMLProviderRulesApi(cloudcheckr_cmx_client.ApiClient(configuration))
customer_id = 'customer_id_example' # str | 
saml_provider_id = 'saml_provider_id_example' # str | 
body = cloudcheckr_cmx_client.CreateRequestSamlProviderRuleRequestModel() # CreateRequestSamlProviderRuleRequestModel |  (optional)

try:
    # Creates a new SAML provider rule for the specified SAML provider.
    api_response = api_instance.create_saml_provider_rule(customer_id, saml_provider_id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SAMLProviderRulesApi->create_saml_provider_rule: %s\n" % e)

Parameters

Name Type Description Notes
customer_id str
saml_provider_id str
body CreateRequestSamlProviderRuleRequestModel [optional]

Return type

SamlProviderRuleResponseModel

Authorization

oauth

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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

delete_saml_provider_rule

delete_saml_provider_rule(customer_id, saml_provider_id, rule_id)

Deletes a SAML provider rule.

Example

from __future__ import print_function
import time
import cloudcheckr_cmx_client
from cloudcheckr_cmx_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = cloudcheckr_cmx_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = cloudcheckr_cmx_client.SAMLProviderRulesApi(cloudcheckr_cmx_client.ApiClient(configuration))
customer_id = 'customer_id_example' # str | 
saml_provider_id = 'saml_provider_id_example' # str | 
rule_id = 'rule_id_example' # str | 

try:
    # Deletes a SAML provider rule.
    api_instance.delete_saml_provider_rule(customer_id, saml_provider_id, rule_id)
except ApiException as e:
    print("Exception when calling SAMLProviderRulesApi->delete_saml_provider_rule: %s\n" % e)

Parameters

Name Type Description Notes
customer_id str
saml_provider_id str
rule_id str

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

list_saml_provider_rules

PaginationWithCountResponseSamlProviderRuleResponseModel list_saml_provider_rules(customer_id, saml_provider_id, page_size=page_size, pagination_key=pagination_key)

Get all SAML provider rules assigned to a SAML provider.

Example

from __future__ import print_function
import time
import cloudcheckr_cmx_client
from cloudcheckr_cmx_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = cloudcheckr_cmx_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = cloudcheckr_cmx_client.SAMLProviderRulesApi(cloudcheckr_cmx_client.ApiClient(configuration))
customer_id = 'customer_id_example' # str | 
saml_provider_id = 'saml_provider_id_example' # str | 
page_size = 56 # int | number of items to include in the response (optional)
pagination_key = 'pagination_key_example' # str | key used to fetch the next page of items (optional)

try:
    # Get all SAML provider rules assigned to a SAML provider.
    api_response = api_instance.list_saml_provider_rules(customer_id, saml_provider_id, page_size=page_size, pagination_key=pagination_key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SAMLProviderRulesApi->list_saml_provider_rules: %s\n" % e)

Parameters

Name Type Description Notes
customer_id str
saml_provider_id str
page_size int number of items to include in the response [optional]
pagination_key str key used to fetch the next page of items [optional]

Return type

PaginationWithCountResponseSamlProviderRuleResponseModel

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

update_saml_provider_rule

SamlProviderRuleResponseModel update_saml_provider_rule(customer_id, saml_provider_id, rule_id, body=body)

Updates a SAML provider rule.

Example

from __future__ import print_function
import time
import cloudcheckr_cmx_client
from cloudcheckr_cmx_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = cloudcheckr_cmx_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = cloudcheckr_cmx_client.SAMLProviderRulesApi(cloudcheckr_cmx_client.ApiClient(configuration))
customer_id = 'customer_id_example' # str | 
saml_provider_id = 'saml_provider_id_example' # str | 
rule_id = 'rule_id_example' # str | 
body = cloudcheckr_cmx_client.UpdateRequestSamlProviderRuleRequestModel() # UpdateRequestSamlProviderRuleRequestModel |  (optional)

try:
    # Updates a SAML provider rule.
    api_response = api_instance.update_saml_provider_rule(customer_id, saml_provider_id, rule_id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SAMLProviderRulesApi->update_saml_provider_rule: %s\n" % e)

Parameters

Name Type Description Notes
customer_id str
saml_provider_id str
rule_id str
body UpdateRequestSamlProviderRuleRequestModel [optional]

Return type

SamlProviderRuleResponseModel

Authorization

oauth

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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