Files
api-specs/idn/beta/schemas/RoleMiningSessionDto.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

80 lines
2.3 KiB
YAML

type: object
properties:
scope:
$ref: './RoleMiningSessionScope.yaml'
description: The scope of identities for this role mining session
example: {
identityIds: [],
criteria: "source.name:DataScienceDataset",
attributeFilterCriteria: {
displayName: {untranslated: "Location: Miami"},
ariaLabel: {untranslated: "Location: Miami"},
data: {
displayName: {translateKey: "IDN.IDENTITY_ATTRIBUTES.LOCATION"},
name: "location",
operator: "EQUALS",
values: ["Miami"]
}
}
}
pruneThreshold:
type: integer
description: The prune threshold to be used or null to calculate prescribedPruneThreshold
nullable: true
example: 5
format: int32
prescribedPruneThreshold:
type: integer
description: The calculated prescribedPruneThreshold
nullable: true
example: 10
format: int32
minNumIdentitiesInPotentialRole:
type: integer
description: Minimum number of identities in a potential role
nullable: true
example: 20
format: int32
potentialRoleCount:
type: integer
description: Number of potential roles
example: 0
format: int32
potentialRolesReadyCount:
type: integer
description: Number of potential roles ready
example: 0
format: int32
status:
$ref: './RoleMiningSessionStatus.yaml'
description: The status of the role mining session
example: CREATED
type:
$ref: './iai/RoleMiningRoleType.yaml'
description: Role mining session type
example: SPECIALIZED
emailRecipientId:
type: string
description: The id of the user who will receive an email about the role mining session
nullable: true
example: "2c918090761a5aac0176215c46a62d58"
createdBy:
oneOf:
- $ref: './iai/EntityCreatedByDTO.yaml'
- $ref: './iai/NullableEntityCreatedByDTO.yaml'
description: The session created by details
identityCount:
type: integer
description: Number of identities in the population which meet the search criteria or identity list provided
example: 0
format: int32
saved:
type: boolean
description: The session's saved status
default: false
example: true
name:
type: string
description: The session's saved name
nullable: true
example: "Saved RM Session - 07/10"