Skip to main content

Create request to provision a potential role into an actual role.

This method starts a job to provision a potential role

Path Parameters
  • sessionId string required

    The role mining session id

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

    A potential role id in a role mining session

    Example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb
Query Parameters
  • min-entitlement-popularity integer

    Possible values: <= 100

    Minimum popularity required for an entitlement to be included in the provisioned role.

  • include-common-access boolean

    Default value: true

    Boolean determining whether common access entitlements will be included in the provisioned role.

Request Body

Required information to create a new role

  • roleName string

    Name of the new role being created

  • roleDescription string

    Short description of the new role being created

  • ownerId string

    ID of the identity that will own this role

Responses

Accepted. Returns a potential role summary including the status of the provison request


Schema
  • potentialRoleRef object

    Details about the potential role

  • id string

    Id of the potential role

  • name string

    Name of the potential role

  • identityCount integer

    The number of identities in a potential role.

  • entitlementCount integer

    The number of entitlements in a potential role.

  • identityGroupStatus string

    The status for this identity group which can be "REQUESTED" or "OBTAINED"

  • provisionState string

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

    The status of provisioning for this potential role. Can be "POTENTIAL", "PENDING", "FAILED", or "COMPLETE".

  • roleId string

    ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned.

  • density integer

    The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities.

  • freshness integer

    The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles.

  • quality integer

    The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness.

Loading...