Create a role mining session

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

application/json

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

• 201
• 400
• 401
• 403
• 429
• 500

---

Submitted a role mining session request

application/json

• Schema
• Example (from schema)

---

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

{
  "scope": {
    "identityIds": [],
    "criteria": "source.name:DataScienceDataset"
  },
  "minNumIdentitiesInPotentialRole": 20,
  "pruneThreshold": 70,
  "prescribedPruneThreshold": 83,
  "potentialRoleCount": 8,
  "potentialRolesReadyCount": 4,
  "status": {
    "state": "POTENTIAL_ROLES_PROCESSING"
  },
  "id": "602ba738-cf48-499b-a780-7b67b3fc1ecf",
  "createdDate": "2021-09-08T16:11:05.348Z",
  "modifiedDate": "2021-09-08T16:11:05.348Z",
  "type": "SPECIALIZED"
}

Client Error - Returned if the request body is invalid.

application/json

• Schema
• Example (from 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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

{
  "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."
    }
  ]
}

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

application/json

• Schema
• Example (from schema)

---

Schema

• error

  A message describing the error

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

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

application/json

• Schema
• Example (from schema)
• 403

---

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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

{
  "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."
    }
  ]
}

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."
    }
  ]
}

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
• Example (from schema)

---

Schema

• message

  A message describing the error

{
  "message": " Rate Limit Exceeded "
}

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

application/json

• Schema
• Example (from schema)
• 500

---

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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

{
  "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."
    }
  ]
}

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