Get Campaign

GET 
/campaigns/:id

Use this API to get information for an existing certification campaign by the campaign's ID.

Request

Path Parameters

id stringrequired
ID of the campaign to be retrieved.
Example: 2c91808571bcfcf80171c23e4b4221fc

Query Parameters

detail string
Possible values: [SLIM, FULL]
Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
Example: FULL

Responses

200

Requested campaign object.

application/json

Schema

Schema

anyOf

Slim Campaign

id string

Id of the campaign

name stringrequired

The campaign name. If this object is part of a template, special formatting applies; see the /campaign-templates/{id}/generate endpoint documentation for details.

description stringnullablerequired

The campaign description. If this object is part of a template, special formatting applies; see the /campaign-templates/{id}/generate endpoint documentation for details.

deadline date-time

The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.

type stringrequired

Possible values: [MANAGER, SOURCE_OWNER, SEARCH, ROLE_COMPOSITION, MACHINE_ACCOUNT]

The type of campaign. Could be extended in the future.

emailNotificationEnabled boolean

Enables email notification for this campaign

autoRevokeAllowed boolean

Allows auto revoke for this campaign

recommendationsEnabled boolean

Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.

status string

Possible values: [PENDING, STAGED, CANCELING, ACTIVATING, ACTIVE, COMPLETING, COMPLETED, ERROR, ARCHIVED]

The campaign's current status.

correlatedStatus string

Possible values: [CORRELATED, UNCORRELATED]

The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).

created date-time

Created time of the campaign

totalCertifications int32

The total number of certifications in this campaign.

completedCertifications int32

The number of completed certifications in this campaign.

alerts

object[]

A list of errors and warnings that have accumulated.

Array [

level string

Possible values: [ERROR, WARN, INFO]

Denotes the level of the message

localizations

object[]

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

Actual text of the error message in the indicated locale.

]

]

Campaign

id string

Id of the campaign

name stringrequired

The campaign name. If this object is part of a template, special formatting applies; see the /campaign-templates/{id}/generate endpoint documentation for details.

description stringnullablerequired

The campaign description. If this object is part of a template, special formatting applies; see the /campaign-templates/{id}/generate endpoint documentation for details.

deadline date-time

The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.

type stringrequired

Possible values: [MANAGER, SOURCE_OWNER, SEARCH, ROLE_COMPOSITION, MACHINE_ACCOUNT]

The type of campaign. Could be extended in the future.

emailNotificationEnabled boolean

Enables email notification for this campaign

autoRevokeAllowed boolean

Allows auto revoke for this campaign

recommendationsEnabled boolean

Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.

status string

Possible values: [PENDING, STAGED, CANCELING, ACTIVATING, ACTIVE, COMPLETING, COMPLETED, ERROR, ARCHIVED]

The campaign's current status.

correlatedStatus string

Possible values: [CORRELATED, UNCORRELATED]

The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).

created date-time

Created time of the campaign

totalCertifications int32

The total number of certifications in this campaign.

completedCertifications int32

The number of completed certifications in this campaign.

alerts

object[]

A list of errors and warnings that have accumulated.

Array [

level string

Possible values: [ERROR, WARN, INFO]

Denotes the level of the message

localizations

object[]

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

Actual text of the error message in the indicated locale.

]

]

modified date-time

Modified time of the campaign

filter

object

Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.

id string

The ID of whatever type of filter is being used.

type string

Possible values: [CAMPAIGN_FILTER, RULE]

Type of the filter

name string

Name of the filter

sunsetCommentsRequired boolean

Default value: true

Determines if comments on sunset date changes are required.

sourceOwnerCampaignInfo

object

Must be set only if the campaign type is SOURCE_OWNER.

sourceIds string[]

The list of sources to be included in the campaign.

searchCampaignInfo

object

Must be set only if the campaign type is SEARCH.

type stringrequired

Possible values: [IDENTITY, ACCESS]

The type of search campaign represented.

description string

Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.

reviewer

object

If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP.

type string

Possible values: [GOVERNANCE_GROUP, IDENTITY]

The reviewer's DTO type.

id string

The reviewer's ID.

name string

The reviewer's name.

query string

The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of query or identityIds must be set.

identityIds string[]

Possible values: <= 1000

A direct list of identities to include in this campaign. One of identityIds or query must be set.

accessConstraints

object[]

Possible values: <= 1000

Further reduces the scope of the campaign by excluding identities (from query or identityIds) that do not have this access.

Array [

type stringrequired

Possible values: [ENTITLEMENT, ACCESS_PROFILE, ROLE]

Type of Access

ids string[]

Must be set only if operator is SELECTED.

operator stringrequired

Possible values: [ALL, SELECTED]

Used to determine whether the scope of the campaign should be reduced for selected ids or all.

]

roleCompositionCampaignInfo

object

Optional configuration options for role composition campaigns.

reviewer

object

If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP.

type string

Possible values: [GOVERNANCE_GROUP, IDENTITY]

The reviewer's DTO type.

id string

The reviewer's ID.

name string

The reviewer's name.

roleIds string[]

Optional list of roles to include in this campaign. Only one of roleIds and query may be set; if neither are set, all roles are included.

remediatorRef

object

required

This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.

type stringrequired

Possible values: [IDENTITY]

Legal Remediator Type

id stringrequired

The ID of the remediator.

name string

The name of the remediator.

query string

Optional search query to scope this campaign to a set of roles. Only one of roleIds and query may be set; if neither are set, all roles are included.

description string

Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.

machineAccountCampaignInfo

object

Must be set only if the campaign type is MACHINE_ACCOUNT.

sourceIds string[]

The list of sources to be included in the campaign.

reviewerType string

Possible values: [ACCOUNT_OWNER]

The reviewer's type.

sourcesWithOrphanEntitlements

object[]

A list of sources in the campaign that contain "orphan entitlements" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).

Array [

id string

Id of the source

type string

Possible values: [SOURCE]

Type

name string

Name of the source

]

mandatoryCommentRequirement string

Possible values: [ALL_DECISIONS, REVOKE_ONLY_DECISIONS, NO_DECISIONS]

Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.

Example (from schema)

{}

Manager

{
  "id": "2c918086719eec070171a7e3355a360a",
  "name": "Manager Review",
  "description": "A review of everyone's access by their manager.",
  "deadline": "2020-12-25T06:00:00.123Z",
  "type": "MANAGER",
  "status": "ACTIVE",
  "emailNotificationEnabled": false,
  "autoRevokeAllowed": false,
  "recommendationsEnabled": false
}

Search

{
  "id": "7e1a731e3fb845cfbe58112ba4673ee4",
  "name": "Search Campaign",
  "description": "Search Campaign Info",
  "deadline": "2022-07-26T15:42:44Z",
  "type": "SEARCH",
  "status": "ACTIVE",
  "emailNotificationEnabled": false,
  "autoRevokeAllowed": false,
  "recommendationsEnabled": false
}

Source Owner

{
  "id": "2c918086719eec070171a7e3355a412b",
  "name": "AD Source Review",
  "description": "A review of our AD source.",
  "deadline": "2020-12-25T06:00:00.123Z",
  "type": "SOURCE_OWNER",
  "status": "STAGED",
  "emailNotificationEnabled": true,
  "autoRevokeAllowed": false,
  "recommendationsEnabled": false,
  "correlatedStatus": "CORRELATED"
}

RoleComposition

{
  "id": "3b2e2e5821e84127b6d693d41c40623b",
  "name": "Role Composition Campaign",
  "description": "A review done by a role owner.",
  "deadline": "2020-12-25T06:00:00.468Z",
  "type": "ROLE_COMPOSITION",
  "status": "ACTIVE",
  "emailNotificationEnabled": false,
  "autoRevokeAllowed": false,
  "recommendationsEnabled": false
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

403

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."
    }
  ]
}

404

Not Found - returned if the request URL refers to a resource or object that does not exist

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

404

An example of a 404 response object

{
  "detailCode": "404 Not found",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server did not find a current representation for the target resource."
    }
  ]
}

429

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

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

500

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."
    }
  ]
}

Loading...