REST API for Notification in OIG

Fetch notification event list

get

/iam/governance/selfservice/api/v1/notification/events

Fetches all the notification events existing in OIG.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

successful operation.

Root Schema : EventList

Type: object

Show Source

events(optional): array events

{
    "type":"object",
    "properties":{
        "events":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : events

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Invalid input.

Examples

The following example shows how to retrieve a paginated list of all execution history within a specified time range by submitting the GET request using cURL. The information shown here is against a pseudo system and serves as a prototype.

The sort field and the sort order are in the format `field: order`. The available values of field are startTime, endTime, and status. The available values of order are desc and asc.

cURL Example

curl -i -X GET -u username:password 
\--header 'Content-Type: application/json' \
'http://pseudo.com:14000/iam/governance/selfservice/api/v1/notification/events'

Example of Response Body

The following example shows the JSON response for a request to retrieve a paginated list of all execution history within a specified time range:

{
    "events": [
        "EndDateNotificationEvent",
        "UserDeletedNotificationEvent",
        "CreateUser",
        "AddProxy",
        "FailedJob",
        "RequestCreation",
        "CreateSelfUser",
        "ForgottenUsername",
        "PasswordExpiration",
        "PasswordWarning",
        "ResetPassword",
        "GeneratePassword",
        "ForgotPasswordWithURL",
        "RequestStatusChange",
        "BulkRequestCreation",
        "FailedAccountCreationNotification",
        "FailedAccountCreationSelfNotification"
    ]
}