Retrieves a specific potential role

GET 
/role-mining-potential-roles/:potentialRoleId

This method returns a specific potential role.

Request

Path Parameters

potentialRoleId stringrequired
A potential role id
Example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb

Responses

200

Succeeded. Returns a list of potential roles for a role mining session.

application/json

Schema

Schema

createdBy

object

The session created by details

oneOf

EntityCreatedByDTO

id string

ID of the creator

displayName string

The display name of the creator

NullableEntityCreatedByDTO

Workaround to support null

string

density int32

The density of a potential role.

description stringnullable

The description of a potential role.

entitlementCount int32

The number of entitlements in a potential role.

excludedEntitlements string[]nullable

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[]

nullable

Identity attribute distribution.

Array [

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 RoleMiningPotentialRoleProvisionState (string)nullable

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

The provisioning state of a potential role.

quality int32

The quality of a potential role.

roleId stringnullable

The roleId of a potential role.

saved boolean

The potential role's saved status.

session

object

The session parameters of the potential role.

id string

The ID of the role mining session

name stringnullable

The session's saved name

minNumIdentitiesInPotentialRole int32nullable

Minimum number of identities in a potential role

pruneThreshold int32nullable

The prune threshold to be used or null to calculate prescribedPruneThreshold

saved boolean

Default value: true

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 stringnullable

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

attributeFilterCriteria object[]nullable

The filter criteria for this role mining session.

type RoleMiningRoleType (string)

Possible values: [SPECIALIZED, COMMON]

Role mining potential type

state RoleMiningSessionState (string)

Possible values: [CREATED, UPDATED, IDENTITIES_OBTAINED, PRUNE_THRESHOLD_OBTAINED, POTENTIAL_ROLES_PROCESSING, POTENTIAL_ROLES_CREATED]

Role mining session state

scopingMethod RoleMiningSessionScopingMethod (string)

Possible values: [MANUAL, AUTO_RM]

Scoping method used in current role mining session

type RoleMiningRoleType (string)

Possible values: [SPECIALIZED, COMMON]

Role mining potential type.

id string

Id of the potential role

createdDate date-time

The date-time when this potential role was created.

modifiedDate date-time

The date-time when this potential role was modified.

Example (from schema)

{
  "createdBy": {},
  "density": 75,
  "description": "Potential Role for Accounting dept",
  "entitlementCount": 25,
  "excludedEntitlements": [
    "07a0b4e2",
    "13b4e2a0"
  ],
  "freshness": 75,
  "identityCount": 25,
  "identityDistribution": [
    {
      "attributeName": "department",
      "distribution": [
        {
          "attributeValue": "NM Tier 3",
          "count": 6
        }
      ]
    }
  ],
  "identityIds": [
    "07a0b4e2",
    "13b4e2a0"
  ],
  "name": "Saved Potential Role - 07/10",
  "provisionState": "POTENTIAL",
  "quality": 100,
  "roleId": "07a0b4e2-7a76-44fa-bd0b-c64654b66519",
  "saved": true,
  "session": {
    "id": "9f36f5e5-1e81-4eca-b087-548959d91c71",
    "name": "Saved RM Session - 07/10",
    "minNumIdentitiesInPotentialRole": 20,
    "pruneThreshold": 5,
    "saved": true,
    "scope": {
      "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"
          ]
        }
      }
    },
    "type": "SPECIALIZED",
    "state": "CREATED",
    "scopingMethod": "MANUAL"
  },
  "type": "SPECIALIZED",
  "id": "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923",
  "createdDate": "2024-07-29T15:51:28.071Z",
  "modifiedDate": "2024-07-29T15:51:28.071Z"
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...