Continuous Dynamic Help DocsContinuous Dynamic Portal Login (US)Continuous Dynamic Portal Login (EU)Customer Support
API Reference

Retrieve all notices for the requesting user

get
https://sentinel.whitehatsec.com/api/user//notice

This operation returns an object containing information about all notices relevant to the specified user.

NOTE: This information cannot be retrieved for any user other than the current user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Username must be a valid email address.

Query Params
string

Retrieves notices created prior to the given timestamp. Requires a valid ISO-8601 (UTC/GMT) date format string. EXAMPLE: 'YYYY-MM-DDThh:mm:ssZ' -> '2008-12-12T21:35:59Z'

string

Retrieves notices created since the given timestamp. Requires a valid ISO-8601 (UTC/GMT) date format string. EXAMPLE: 'YYYY-MM-DDThh:mm:ssZ' -> '2008-12-12T21:35:59Z'

string

Retrieves notices expired prior to the given timestamp. Requires a valid ISO-8601 (UTC/GMT) date format string. EXAMPLE: 'YYYY-MM-DDThh:mm:ssZ' -> '2008-12-12T21:35:59Z'

string

Retrieves notices expired since the given timestamp. Requires a valid ISO-8601 (UTC/GMT) date format string. EXAMPLE: 'YYYY-MM-DDThh:mm:ssZ' -> '2008-12-12T21:35:59Z'

string
enum

Retrieves notices with expiration set to "Never Expires" if set to 1 & notices with expiration not set to "Never Expires" if set to 0.

Allowed:
string
enum

Retrieves notices with type 'bulletin' if frequency of notice is set to 'once' & with type 'system_maintenance' if frequency of notice is set to 'always'.

Allowed:
string

Retrieves notices with title that match part or all of what is given. EXAMPLE: Given a value of 'abc', this parameter would fetch notices with titles of 'abctest', 'testabc', and 'test_abc'.

string

Retrieves notices with message that match part or all of what is given. EXAMPLE: Given a value of 'abc', this parameter would fetch notices with messages of 'abctest', 'testabc', and 'test_abc'.

string
enum
Defaults to 1

Retrieves active notices if set to 1 & inactive notices if set to 0.

Allowed:
string
enum
Defaults to en

Retrieves notices with given locales. EXAMPLE: 'en' will fetch notices with English language & 'ja' will fetch notices with Japanese language.

Allowed:
string
enum
Defaults to json

Selects the requested response representation format.

Allowed:
Responses

400

BadRequestResponse indicates a request with invalid parameters.

401

UnauthorizedResponse signals an unauthorized API access.

403

ForbiddenResponse signals a request for a resource that does not exist or is not authorized.

404

NotFoundResponse indicates a request for a resource that does not exist.

500

GenericError generic error.

Updated over 3 years ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated over 3 years ago