Skip to main content

Create a role mining session

This submits a create role mining session request to the role mining application.

Request Body required

Role mining session parameters

  • scope object

    The scope of identities for this role mining session

  • identityIds string[]

    The list of identities for this role mining session.

  • criteria string

    The "search" criteria that produces the list of identities for this role mining session.

  • attributeFilterCriteria object[]

    The filter criteria for this role mining session.

  • pruneThreshold int32

    The prune threshold to be used or null to calculate prescribedPruneThreshold

  • prescribedPruneThreshold int32

    The calculated prescribedPruneThreshold

  • minNumIdentitiesInPotentialRole int32

    Minimum number of identities in a potential role

  • potentialRoleCount int32

    Number of potential roles

  • potentialRolesReadyCount int32

    Number of potential roles ready

  • status object

    The status of the role mining session

  • state string

    The role mining session status. Can be one of these states - CREATED|UPDATED|IDENTITIES_OBTAINED|PRUNE_THRESHOLD_OBTAINED|POTENTIAL_ROLES_PROCESSING|POTENTIAL_ROLES_CREATED

  • type string

    Possible values: [SPECIALIZED, COMMON]

    Role mining session type

  • emailRecipientId string

    The id of the user who will receive an email about the role mining session

  • createdBy object

    The session created by details

  • id string

    ID of the creator

  • displayName string

    The display name of the creator

  • identityCount int32

    Number of identities in the population which meet the search criteria or identity list provided

  • saved boolean

    The session's saved status

  • name string

    The session's saved name

Responses

Submitted a role mining session request


Schema
  • scope object

    The scope of identities for this role mining session

  • identityIds string[]

    The list of identities for this role mining session.

  • criteria string

    The "search" criteria that produces the list of identities for this role mining session.

  • attributeFilterCriteria object[]

    The filter criteria for this role mining session.

  • minNumIdentitiesInPotentialRole integer

    Minimum number of identities in a potential role

  • prescribedPruneThreshold integer

    The computed (or prescribed) prune threshold for this session

  • pruneThreshold integer

    The prune threshold to be used for this role mining session

  • potentialRoleCount integer

    The number of potential roles

  • potentialRolesReadyCount integer

    The number of potential roles which have completed processing

  • status object

    The role mining session status

  • state string

    The role mining session status. Can be one of these states - CREATED|UPDATED|IDENTITIES_OBTAINED|PRUNE_THRESHOLD_OBTAINED|POTENTIAL_ROLES_PROCESSING|POTENTIAL_ROLES_CREATED

  • id string

    Session Id for this role mining session

  • createdDate date-time

    The date-time when this role mining session was created.

  • modifiedDate date-time

    The date-time when this role mining session was completed.

  • type string

    Possible values: [SPECIALIZED, COMMON]

    Role mining session type

Loading...