Files
api-specs/idn/beta/paths/role-mining-potential-role-source-identity-usage.yaml
GitHub Action Bot 8fc822a2d8 Automated commit 'IDA-20950 Add role-mining-potential-roles paths (#1465)
* IDA-20950 add role-mining-potential-roles paths, including identityUsage

* IDA-20950 update summaries, security

* IDA-20950 validation fixes

* IDA-20950 fixes for RoleMiningPotentialRoleSummary.yaml

* IDA-20950 remove top level example

* IDA-20950 add examples

* IDA-20950 use nullable attribute

* IDA-20950 move the potential role endpoints to the end of the Role Mining section

* IDA-20950 more updates

* IDA-20950 add nullable

* IDA-20950 more nullable updates

* IDA-20950 fix enums

* IDA-20950 add RoleMiningSessionState.yaml

* IDA-20950 use oneOf instead of nullable

* IDA-20950 the SDK generators don't like oneOf w/ null.   Try nullable for the object.

* IDA-20950 Go SDK generator doesn't like the NullableEntityCreatedByDTO.yaml

* IDA-20950 another attempt to appease the GO SDK generator

* IDA-20950 appease OpenAPI lint

* IDA-20950 dummy example

* IDA-20950 add RoleMiningPotentialRoleSourceUsage.yaml

* IDA-20950 added activity data properties to RoleMiningEntitlement.yaml

* IDA-20950 remove existing top-level example

* IDA-20950 add examples for RoleMiningEntitlement and RoleMiningEntitlementRef' by github action: 6669293862
2023-10-27 15:38:06 +00:00

59 lines
1.8 KiB
YAML

get:
operationId: getPotentialRoleSourceIdentityUsage
summary: Retrieves potential role source usage
tags:
- IAI Role Mining
description: >-
This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role.
security:
- UserContextAuth: []
parameters:
- in: path
name: potentialRoleId
schema:
type: string
required: true
description: A potential role id
example: e0cc5d7d-bf7f-4f81-b2af-8885b09d9923
- in: path
name: sourceId
schema:
type: string
required: true
description: A source id
example: 2c9180877620c1460176267f336a106f
- in: query
name: sorters
required: false
style: form
explode: true
schema:
type: string
format: comma-separated
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/)
Sorting is supported for the following fields: **displayName, email, usageCount**
example: '-usageCount'
- $ref: '../../v3/parameters/offset.yaml'
- $ref: '../../v3/parameters/limit.yaml'
- $ref: '../../v3/parameters/count.yaml'
responses:
'200':
description: Succeeded. Returns a list of source usage for the identities in a potential role.
content:
application/json:
schema:
type: array
items:
$ref: '../schemas/RoleMiningPotentialRoleSourceUsage.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'