Create a role mining session
POST/role-mining-sessions
This submits a create role mining session request to the role mining application.
Request
- application/json
Body
required
Role mining session parameters
- EntityCreatedByDTO
- NullableEntityCreatedByDTO
scope object
The scope of identities for this role mining session
The list of identities for this role mining session.
The "search" criteria that produces the list of identities for this role mining session.
The filter criteria for this role mining session.
The prune threshold to be used or null to calculate prescribedPruneThreshold
The calculated prescribedPruneThreshold
Minimum number of identities in a potential role
Number of potential roles
Number of potential roles ready
status object
The status of the role mining session
Possible values: [CREATED
, UPDATED
, IDENTITIES_OBTAINED
, PRUNE_THRESHOLD_OBTAINED
, POTENTIAL_ROLES_PROCESSING
, POTENTIAL_ROLES_CREATED
]
Role mining session state
Possible values: [SPECIALIZED
, COMMON
]
Role mining session type
The id of the user who will receive an email about the role mining session
createdBy object
The session created by details
ID of the creator
The display name of the creator
string
Number of identities in the population which meet the search criteria or identity list provided
Default value: false
The session's saved status
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
The list of identities for this role mining session.
The "search" criteria that produces the list of identities for this role mining session.
The filter criteria for this role mining session.
Minimum number of identities in a potential role
The computed (or prescribed) prune threshold for this session
The prune threshold to be used for this role mining session
The number of potential roles
The number of potential roles which have completed processing
status object
The role mining session status
Possible values: [CREATED
, UPDATED
, IDENTITIES_OBTAINED
, PRUNE_THRESHOLD_OBTAINED
, POTENTIAL_ROLES_PROCESSING
, POTENTIAL_ROLES_CREATED
]
Role mining session state
Session Id for this role mining session
The date-time when this role mining session was created.
The date-time when this role mining session was completed.
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
- Array [
- ]
- Array [
- ]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
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
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
- Array [
- ]
- Array [
- ]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
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
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
- Array [
- ]
- Array [
- ]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
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."
}
]
}