Skip to content

ApplicationFeaturesApi.md

Latest commit

 

History

History
275 lines (190 loc) · 9.35 KB

ApplicationFeaturesApi.md

File metadata and controls

275 lines (190 loc) · 9.35 KB

okta.ApplicationFeaturesApi

All URIs are relative to https://subdomain.okta.com

Method HTTP request Description
get_feature_for_application GET /api/v1/apps/{appId}/features/{featureName} Retrieve a Feature
list_features_for_application GET /api/v1/apps/{appId}/features List all Features
update_feature_for_application PUT /api/v1/apps/{appId}/features/{featureName} Update a Feature

get_feature_for_application

ApplicationFeature get_feature_for_application(app_id, feature_name)

Retrieve a Feature

Retrieves a Feature object for an application

Example

  • Api Key Authentication (apiToken):
  • OAuth Authentication (oauth2):
import okta
from okta.models.application_feature import ApplicationFeature
from okta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://subdomain.okta.com
# See configuration.py for a list of all supported configuration parameters.
configuration = okta.Configuration(
    host = "https://subdomain.okta.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 API key authorization: apiToken
configuration.api_key['apiToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiToken'] = 'Bearer'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with okta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = okta.ApplicationFeaturesApi(api_client)
    app_id = '0oafxqCAJWWGELFTYASJ' # str | ID of the Application
    feature_name = 'USER_PROVISIONING' # str | Name of the Feature

    try:
        # Retrieve a Feature
        api_response = api_instance.get_feature_for_application(app_id, feature_name)
        print("The response of ApplicationFeaturesApi->get_feature_for_application:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApplicationFeaturesApi->get_feature_for_application: %s\n" % e)

Parameters

Name Type Description Notes
app_id str ID of the Application
feature_name str Name of the Feature

Return type

ApplicationFeature

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
403 Forbidden -
404 Not Found -
429 Too Many Requests -

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

list_features_for_application

List[ApplicationFeature] list_features_for_application(app_id)

List all Features

Lists all features for an application > Note: The only application feature currently supported is USER_PROVISIONING. > This request returns an error if provisioning isn't enabled for the application. > To set up provisioning, see Update the default Provisioning Connection.

Example

  • Api Key Authentication (apiToken):
  • OAuth Authentication (oauth2):
import okta
from okta.models.application_feature import ApplicationFeature
from okta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://subdomain.okta.com
# See configuration.py for a list of all supported configuration parameters.
configuration = okta.Configuration(
    host = "https://subdomain.okta.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 API key authorization: apiToken
configuration.api_key['apiToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiToken'] = 'Bearer'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with okta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = okta.ApplicationFeaturesApi(api_client)
    app_id = '0oafxqCAJWWGELFTYASJ' # str | ID of the Application

    try:
        # List all Features
        api_response = api_instance.list_features_for_application(app_id)
        print("The response of ApplicationFeaturesApi->list_features_for_application:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApplicationFeaturesApi->list_features_for_application: %s\n" % e)

Parameters

Name Type Description Notes
app_id str ID of the Application

Return type

List[ApplicationFeature]

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
404 Not Found -
429 Too Many Requests -

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

update_feature_for_application

ApplicationFeature update_feature_for_application(app_id, feature_name, capabilities_object)

Update a Feature

Updates a Feature object for an application > Note: This endpoint supports partial updates.

Example

  • Api Key Authentication (apiToken):
  • OAuth Authentication (oauth2):
import okta
from okta.models.application_feature import ApplicationFeature
from okta.models.capabilities_object import CapabilitiesObject
from okta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://subdomain.okta.com
# See configuration.py for a list of all supported configuration parameters.
configuration = okta.Configuration(
    host = "https://subdomain.okta.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 API key authorization: apiToken
configuration.api_key['apiToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiToken'] = 'Bearer'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with okta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = okta.ApplicationFeaturesApi(api_client)
    app_id = '0oafxqCAJWWGELFTYASJ' # str | ID of the Application
    feature_name = 'USER_PROVISIONING' # str | Name of the Feature
    capabilities_object = okta.CapabilitiesObject() # CapabilitiesObject | 

    try:
        # Update a Feature
        api_response = api_instance.update_feature_for_application(app_id, feature_name, capabilities_object)
        print("The response of ApplicationFeaturesApi->update_feature_for_application:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApplicationFeaturesApi->update_feature_for_application: %s\n" % e)

Parameters

Name Type Description Notes
app_id str ID of the Application
feature_name str Name of the Feature
capabilities_object CapabilitiesObject

Return type

ApplicationFeature

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
404 Not Found -
429 Too Many Requests -

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