Skip to main content

Update a potential role​

The method updates an existing potential role using.

The following fields can be modified:

  • description

  • name

  • saved

NOTE: All other fields can not be modified.

Path Parameters
  • sessionId string required

    The role mining session id

    Example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb
  • potentialRoleId string required

    The potential role summary id

    Example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb
Request Body array required
  • op string

    Possible values: [remove, replace]

    The operation to be performed

Responses

Succeeded. Returns the potential role summary based on the potentialRoleId provided.


Schema
  • createdBy object

    The session created by details.

  • id string

    ID of the creator

  • displayName string

    The display name of the creator

  • density int32

    The density of a potential role.

  • description string

    The description of a potential role.

  • entitlementCount int32

    The number of entitlements in a potential role.

  • excludedEntitlements string[]

    The list of entitlement ids to be excluded.

  • freshness int32

    The freshness of a potential role.

  • identityCount int32

    The number of identities in a potential role.

  • identityDistribution object[]

    Identity attribute distribution.

  • attributeName string

    Id of the potential role

  • distribution object[]
  • identityIds string[]

    The list of ids in a potential role.

  • name string

    Name of the potential role.

  • provisionState string

    Possible values: [POTENTIAL, PENDING, COMPLETE, FAILED]

    The provisioning state of a potential role.

  • quality int32

    The quality of a potential role.

  • roleId string

    The roleId of a potential role.

  • saved boolean

    The potential role's saved status.

  • session object

    The session parameters of the potential role.

  • minNumIdentitiesInPotentialRole int32

    Minimum number of identities in a potential role

  • name string

    The session's saved name

  • pruneThreshold int32

    The prune threshold to be used or null to calculate prescribedPruneThreshold

  • saved boolean

    The session's saved status

  • 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.

  • type string

    Possible values: [SPECIALIZED, COMMON]

    Role mining potential type

  • type string

    Possible values: [SPECIALIZED, COMMON]

    Role mining potential type.

Loading...