Documentation Powered by ReDoc

Access Risk Management Public API (1.0)

Download OpenAPI specification:Download

Eam

Contains a collection of endpoints that allow EAM operations.

Gets a collection of EAM profiles for the specified ERP system.

path Parameters
erpSystemId
required
integer <int32> [ 1 .. 2147483647 ]

The id of the ERP system to query.

Responses

Response samples

Content type
text/plain
text/plain
application/json
text/json
No sample

Gets a collection of EAM profiles for the specified ERP system and user.

path Parameters
erpSystemId
required
integer <int32> [ 1 .. 2147483647 ]

The id of the ERP system to query.

userId
required
string <uuid>

The id of the user that can utilize the profiles.

Responses

Response samples

Content type
text/plain
text/plain
application/json
text/json
No sample

Gets the state of a particular EAM request.

path Parameters
requestId
required
string <uuid>

The id of the EAM request to query.

Responses

Response samples

Content type
text/plain
text/plain
application/json
text/json
No sample

Downloads the report related to the specified EAM request.

path Parameters
requestId
required
string <uuid>

The identifier of the EAM request.

Responses

Response samples

Content type
text/plain
text/plain
application/json
text/json
No sample

Creates a new EAM request.

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

The object containing the parameters to create the new EAM request.

id
required
string <uuid>
profileId
required
string <uuid>
requesterUserId
required
string <uuid>
reason
required
string
transactionRequested
required
string
comments
string Nullable
startDate
required
string <date-time>
timeZoneId
required
string
required
object
initialState
string
Enum: "Submitted" "AwaitingApproval" "Approved" "Rejected" "AwaitingReview" "Accepted" "Contested" "AccessProvisioned" "GeneratingUsageReport" "Created" "Updated" "Retracted" "Error"

Responses

Request samples

Content type
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "requesterUserId": "9f4de474-a81a-4058-bdf9-c5e1d8c1a9af",
  • "reason": "string",
  • "transactionRequested": "string",
  • "comments": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "timeZoneId": "string",
  • "duration": {
    },
  • "initialState": "Submitted"
}

Response samples

Content type
text/plain
text/plain
application/json
text/json
No sample

Lookup

Contains a collection of endpoints that allow "look up" information.

Get all the users for a particular Customer and Erp system.

path Parameters
customerId
required
string <uuid>

Id of the customer

erpSystemId
required
integer <int32> [ 1 .. 2147483647 ]

Id of the erp system.

query Parameters
search
string

Optional filter criteria.

Responses