mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 12:27:47 +00:00
starting point for adding python sdk docs
This commit is contained in:
darrell-thobe-sp
337
docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md
Normal file
337
docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md
Normal file
@@ -0,0 +1,337 @@
|
||||
---
|
||||
id: beta-o-auth-clients
|
||||
title: OAuth_Clients
|
||||
pagination_label: OAuth_Clients
|
||||
sidebar_label: OAuth_Clients
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'OAuth_Clients', 'BetaOAuth_Clients']
|
||||
slug: /tools/sdk/python/beta/methods/o-auth-clients
|
||||
tags: ['SDK', 'Software Development Kit', 'OAuth_Clients', 'BetaOAuth_Clients']
|
||||
---
|
||||
|
||||
# sailpoint.beta.OAuthClientsApi
|
||||
Use this API to implement OAuth client functionality.
|
||||
With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API.
|
||||
Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API.
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_oauth_client**](OAuthClientsApi#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client
|
||||
[**delete_oauth_client**](OAuthClientsApi#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client
|
||||
[**get_oauth_client**](OAuthClientsApi#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client
|
||||
[**list_oauth_clients**](OAuthClientsApi#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients
|
||||
[**patch_oauth_client**](OAuthClientsApi#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client
|
||||
|
||||
|
||||
## create-oauth-client
|
||||
Create OAuth Client
|
||||
This creates an OAuth client.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-oauth-client)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | create_o_auth_client_request | [**CreateOAuthClientRequest**](../models/create-o-auth-client-request) | True |
|
||||
|
||||
### Return type
|
||||
[**CreateOAuthClientResponse**](../models/create-o-auth-client-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Request succeeded. | CreateOAuthClientResponse | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.beta
|
||||
from sailpoint.beta.models.create_o_auth_client_request import CreateOAuthClientRequest
|
||||
from sailpoint.beta.models.create_o_auth_client_response import CreateOAuthClientResponse
|
||||
from sailpoint.beta.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
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",
|
||||
"refreshTokenValiditySeconds" : 86400,
|
||||
"type" : "CONFIDENTIAL",
|
||||
"redirectUris" : [ "http://localhost:12345", "http://localhost:67890" ],
|
||||
"enabled" : true,
|
||||
"accessType" : "OFFLINE",
|
||||
"grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ],
|
||||
"strongAuthSupported" : false,
|
||||
"homepageUrl" : "http://localhost:12345",
|
||||
"accessTokenValiditySeconds" : 750,
|
||||
"scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ],
|
||||
"name" : "Demo API Client",
|
||||
"claimsSupported" : false
|
||||
} # CreateOAuthClientRequest |
|
||||
|
||||
try:
|
||||
# Create OAuth Client
|
||||
Result = create_o_auth_client_request.from_json(create_o_auth_client_request)
|
||||
api_response = api_instance.create_oauth_client(Result)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.create_oauth_client(Result)
|
||||
print("The response of OAuthClientsApi->create_oauth_client:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-oauth-client
|
||||
Delete OAuth Client
|
||||
This deletes an OAuth client.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-oauth-client)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The OAuth client id
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
204 | No content. | | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.beta
|
||||
from sailpoint.beta.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
|
||||
|
||||
try:
|
||||
# Delete OAuth Client
|
||||
|
||||
api_instance.delete_oauth_client(id)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_instance.delete_oauth_client(id)
|
||||
except Exception as e:
|
||||
print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-oauth-client
|
||||
Get OAuth Client
|
||||
This gets details of an OAuth client.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-oauth-client)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The OAuth client id
|
||||
|
||||
### Return type
|
||||
[**GetOAuthClientResponse**](../models/get-o-auth-client-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Request succeeded. | GetOAuthClientResponse | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.beta
|
||||
from sailpoint.beta.models.get_o_auth_client_response import GetOAuthClientResponse
|
||||
from sailpoint.beta.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
|
||||
|
||||
try:
|
||||
# Get OAuth Client
|
||||
|
||||
api_response = api_instance.get_oauth_client(id)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.get_oauth_client(id)
|
||||
print("The response of OAuthClientsApi->get_oauth_client:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-oauth-clients
|
||||
List OAuth Clients
|
||||
This gets a list of OAuth clients.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-oauth-clients)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Query | filters | **str** | (optional) | 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*
|
||||
|
||||
### Return type
|
||||
[**List[GetOAuthClientResponse]**](../models/get-o-auth-client-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of OAuth clients. | List[GetOAuthClientResponse] | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.beta
|
||||
from sailpoint.beta.models.get_o_auth_client_response import GetOAuthClientResponse
|
||||
from sailpoint.beta.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
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
|
||||
|
||||
api_response = api_instance.list_oauth_clients()
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.list_oauth_clients(filters)
|
||||
print("The response of OAuthClientsApi->list_oauth_clients:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-oauth-client
|
||||
Patch OAuth Client
|
||||
This performs a targeted update to the field(s) of an OAuth client.
|
||||
Request will require a security scope of
|
||||
- sp:oauth-client:manage
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-oauth-client)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The OAuth client id
|
||||
Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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
|
||||
|
||||
### Return type
|
||||
[**GetOAuthClientResponse**](../models/get-o-auth-client-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. | GetOAuthClientResponse | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json-patch+json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.beta
|
||||
from sailpoint.beta.models.get_o_auth_client_response import GetOAuthClientResponse
|
||||
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
|
||||
from sailpoint.beta.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
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
|
||||
|
||||
|
||||
try:
|
||||
# Patch OAuth Client
|
||||
Result = json_patch_operation.from_json(json_patch_operation)
|
||||
api_response = api_instance.patch_oauth_client(id, Result)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.patch_oauth_client(id, Result)
|
||||
print("The response of OAuthClientsApi->patch_oauth_client:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user