starting point for adding python sdk docs

This commit is contained in:
darrell-thobe-sp
2025-02-20 12:59:19 -05:00
parent 3b9e39ca19
commit c18583ede4
2726 changed files with 370294 additions and 5 deletions

View File

@@ -0,0 +1,85 @@
---
id: beta-access-request-identity-metrics
title: Access_Request_Identity_Metrics
pagination_label: Access_Request_Identity_Metrics
sidebar_label: Access_Request_Identity_Metrics
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Access_Request_Identity_Metrics', 'BetaAccess_Request_Identity_Metrics']
slug: /tools/sdk/python/beta/methods/access-request-identity-metrics
tags: ['SDK', 'Software Development Kit', 'Access_Request_Identity_Metrics', 'BetaAccess_Request_Identity_Metrics']
---
# sailpoint.beta.AccessRequestIdentityMetricsApi
Use this API to implement access request identity metrics functionality.
With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity.
This allows reviewers to see how many of the identities who share a manager with the access requester have this same type of access and how many of them have had activity in the related source.
This additional context about whether the access has been granted before and how often it has been used can help those approving access requests make more informed decisions.
All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_access_request_identity_metrics**](AccessRequestIdentityMetricsApi#get-access-request-identity-metrics) | **GET** `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics
## get-access-request-identity-metrics
Return access request identity metrics
Use this API to return information access metrics.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-identity-metrics)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | identity_id | **str** | True | Manager's identity ID.
Path | requested_object_id | **str** | True | Requested access item's ID.
Path | type | **str** | True | Requested access item's type.
### Return type
**object**
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Summary of the resource access and source activity for the direct reports of the provided manager. | object | - |
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.rest import ApiException
from pprint import pprint
identity_id = '7025c863-c270-4ba6-beea-edf3cb091573' # str | Manager's identity ID. # str | Manager's identity ID.
requested_object_id = '2db501be-f0fb-4cc5-a695-334133c52891' # str | Requested access item's ID. # str | Requested access item's ID.
type = 'ENTITLEMENT' # str | Requested access item's type. # str | Requested access item's type.
try:
# Return access request identity metrics
api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type)
print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e)
```
[[Back to top]](#)