Deprecated - Retrieve the campaign configurations.

get https://{tenanturl}/v1.0/admin/campaigns

The api to get a campaign configurations v1.0 (v1.0/admin/campaigns) is deprecated. The end of life is 31-Dec-2025. Use the following alternative API: GET /v2.0/campaigns
Get campaign configurations and manage them. The administrator can see all the campaign configurations for the specified tenant. Application owner can see only the campaigns he created OR those containing at least one Application he owns.
Entitlements required: manageAccessCertification [Manage Access Certification].

Query Params

type

string

Defaults to all

The filter for the campaign configuration type: userassignment, groupassignment, or account.

priority

string

Defaults to all

The filter for the campaign configuration priority: high, medium, or low.

preview

string

Defaults to all

The filter for getting preview campaign configurations: yes, no.

continuous

string

Defaults to all

The filter for getting continuous campaign configurations: yes, no.

filter

string

The generic filter for returning campaign configurations that contain the passed string in one of the following attributes: name (Campaign configuration name).

sort

string

The attribute of the campaign configuration that is used to sort results. The possible values are: owner, launchdate, name, type, priority.

When you provide,
owner:The owner's fullName is used for sorting.
launchdate:The launchDate timestamp is used for sorting.
name: The campaign configuration name is used for sorting.
type:The campaign configuration type is used for sorting.
priority:The campaign configuration priority is used for sorting.
createdOn: The campaign configuration creationDate timestamp is used for sorting.

sortDesc

boolean

Defaults to true

Decides sort order.

limit

string

Defaults to 500

Specifies the maximum number of resources that the search returns for a page.

page

string

Defaults to 1

Page number.

Responses

Response body

array of objects

object

totalCount

integer

Total number of objects.

count

integer

Number of filtered objects.

page

integer

Page number to be returned.

limit

integer

The maximum number of elements to be returned.

resources

array of objects

List of objects.

resources

object

owner

object

Represents a user group

type

string

required

Campaign Type

userassignment groupassignment account all

priority

string

required

Campaign Priority

high medium low all

name

string

required

Campaign Name

description

string

Campaign Description

reviewer

object

Represents a user group

applications

array of objects

required

The list of Applications certified by the campaign.

applications*

object

string

name

string

icon

string

application icon

url

string

application url

description

string

application description

userFilter

object

List of Users or Groups to be included or exluded or filter for users allowed for the certification

entitlementFilter

object

Rest representation for an entitlement or entitlement condition set filter.

launchDate

date-time

The start date of the first instance of campaign.

yyyy-MM-dd'T'HH:mm:ss

creationDate

date-time

The creation date of the campaign configuration.

yyyy-MM-dd'T'HH:mm:ss null

duration

int64

The duration (in milliseconds) for which each campaign instance remains open.

frequency

object

A UNIX or Linux Cron compatible string that defines the start of subsequent instances

runNow

boolean

The flag indicating the campaign occurs one-time and needs to be started immediately.

nextRunDate

date-time

Forecasted Run date for the next campaign instance.

yyyy-MM-dd'T'HH:mm:ss null

overdueAction

string

The action to be taken for open records when a campaign closes.

rejectAll approveAll doNothing

mitigationAction

object

The action to be taken after a while to avoid open records when a campaign closes

defaultReviewer

object

Represents a user group

preview

boolean

A flag indicating that the campaign is in preview mode and not open to reviewers.

signOff

string

The campaign sign-off policy.

auto manual eoc no_signoff

supervisors

array of objects

The list of supervisors identified for the campaign.

supervisors

object

string

name

string

formatted

string

givenName

string

familyName

string

realm

string

userType

string

description

string

allowSupervisorEscalation

boolean

Allow escalation to the supervisors.

reviewerType

string

The Reviewer identifer for the campaign.

reviewerOverwritten

boolean

500

Server error

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://tenant_url/v1.0/admin/campaigns?type=all&priority=all&preview=all&continuous=all&sortDesc=true&limit=500&page=1' \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Success

400Generic application error status. The error code and description are available in the payload.