LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to python SDK docs: 13820107626

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-12 19:41:45 +00:00
parent 184517209d
commit 113200f5fe
221 changed files with 8723 additions and 7883 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md
View File

@@ -57,7 +57,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.create_o_auth_client_request import CreateOAuthClientRequest
@@ -66,8 +65,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_o_auth_client_request = {
create_o_auth_client_request = '''{
"internal" : false,
"businessName" : "Acme-Solar",
"description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows",
@@ -83,18 +83,17 @@ with ApiClient(configuration) as api_client:
"scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ],
"name" : "Demo API Client",
"claimsSupported" : false
} # CreateOAuthClientRequest |
}''' # CreateOAuthClientRequest |
try:
# Create OAuth Client
new_create_o_auth_client_request = CreateOAuthClientRequest()
new_create_o_auth_client_request.from_json(create_o_auth_client_request)
results =OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request)
new_create_o_auth_client_request = CreateOAuthClientRequest.from_json(create_o_auth_client_request)
results = OAuthClientsApi(api_client).create_oauth_client(create_o_auth_client_request=new_create_o_auth_client_request)
# Below is a request that includes all optional parameters
# results = OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request)
print("The response of OAuthClientsApi->create_oauth_client:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e)
```
@@ -135,23 +134,23 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
try:
# Delete OAuth Client
OAuthClientsApi(api_client).delete_oauth_client(id)
OAuthClientsApi(api_client).delete_oauth_client(id=id)
# Below is a request that includes all optional parameters
# OAuthClientsApi(api_client).delete_oauth_client(id)
except Exception as e:
except Exception as e:
print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e)
```
@@ -192,7 +191,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_o_auth_client_response import GetOAuthClientResponse
@@ -200,18 +198,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
try:
# Get OAuth Client
results =OAuthClientsApi(api_client).get_oauth_client(id)
results = OAuthClientsApi(api_client).get_oauth_client(id=id)
# Below is a request that includes all optional parameters
# results = OAuthClientsApi(api_client).get_oauth_client(id)
print("The response of OAuthClientsApi->get_oauth_client:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e)
```
@@ -251,7 +250,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_o_auth_client_response import GetOAuthClientResponse
@@ -259,18 +257,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional)
try:
# List OAuth Clients
results =OAuthClientsApi(api_client).list_oauth_clients()
results = OAuthClientsApi(api_client).list_oauth_clients()
# Below is a request that includes all optional parameters
# results = OAuthClientsApi(api_client).list_oauth_clients(filters)
print("The response of OAuthClientsApi->list_oauth_clients:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e)
```
@@ -312,7 +311,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_o_auth_client_response import GetOAuthClientResponse
@@ -321,26 +319,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}] # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported
json_patch_operation = '''[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported
try:
# Patch OAuth Client
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = OAuthClientsApi(api_client).patch_oauth_client(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation)
print("The response of OAuthClientsApi->patch_oauth_client:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e)
```