Skip to main content

Get a Campaign Template

GET 
https://sailpoint.api.identitynow.com/v2024/campaign-templates/:id

Use this API to fetch a certification campaign template by ID.

Request​

Path Parameters

    id stringrequired

    Requested campaign template's ID.

    Example: 2c9180835d191a86015d28455b4a2329

Responses​

Data for the campaign matching the given ID.

Schema
    idstring

    Id of the campaign template

    Example: 2c9079b270a266a60170a277bb960008
    namestringrequired

    This template's name. Has no bearing on generated campaigns' names.

    Example: Manager Campaign Template
    descriptionstringrequired

    This template's description. Has no bearing on generated campaigns' descriptions.

    Example: Template for the annual manager campaign.
    createddate-timerequired

    Creation date of Campaign Template

    Example: 2020-03-05T22:44:00.364Z
    modifieddate-timenullablerequired

    Modification date of Campaign Template

    Example: 2020-03-05T22:52:09.969Z
    scheduledboolean

    Indicates if this campaign template has been scheduled.

    Default value: false
    Example: false
    ownerRef object

    The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.

    idstring

    Id of the owner

    Example: 2c918086676d3e0601677611dbde220f
    typestring

    Type of the owner

    Possible values: [IDENTITY]

    Example: IDENTITY
    namestring

    Name of the owner

    Example: Mister Manager
    emailstring

    Email of the owner

    Example: mr.manager@example.com
    deadlineDurationstringnullable

    The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was "P2W" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days).

    Example: P2W
    campaign object
    idstringnullable

    Id of the campaign

    Example: 2c9079b270a266a60170a2779fcb0007
    namestringrequired

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

    Example: Manager Campaign
    descriptionstringnullablerequired

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

    Example: Everyone needs to be reviewed by their manager
    deadlinedate-timenullable

    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.

    Example: 2020-03-15T10:00:01.456Z
    typestringrequired

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

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

    Example: MANAGER
    emailNotificationEnabledboolean

    Enables email notification for this campaign

    Default value: false
    Example: false
    autoRevokeAllowedboolean

    Allows auto revoke for this campaign

    Default value: false
    Example: false
    recommendationsEnabledboolean

    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.

    Default value: false
    Example: true
    statusstringnullable

    The campaign's current status.

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

    Example: ACTIVE
    correlatedStatusstring

    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).

    Possible values: [CORRELATED, UNCORRELATED]

    Example: CORRELATED
    createddate-timenullable

    Created time of the campaign

    Example: 2020-03-03T22:15:13.611Z
    totalCertificationsint32nullable

    The total number of certifications in this campaign.

    Example: 100
    completedCertificationsint32nullable

    The number of completed certifications in this campaign.

    Example: 10
    alerts object[]nullable

    A list of errors and warnings that have accumulated.

  • Array [
    • levelstring

    Denotes the level of the message

    Possible values: [ERROR, WARN, INFO]

    Example: ERROR
    localizations object[]
  • Array [
    • localestringnullable

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

    Example: en-US
    localeOriginstringnullable

    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.

    Possible values: [DEFAULT, REQUEST, null]

    Example: DEFAULT
    textstring

    Actual text of the error message in the indicated locale.

    Example: The request was syntactically correct but its content is semantically invalid.
  • ]
  • ]
    • modifieddate-timenullable

    Modified time of the campaign

    Example: 2020-03-03T22:20:12.674Z
    filter objectnullable

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

    idstring

    The ID of whatever type of filter is being used.

    Example: 0fbe863c063c4c88a35fd7f17e8a3df5
    typestring

    Type of the filter

    Possible values: [CAMPAIGN_FILTER, RULE]

    Example: CAMPAIGN_FILTER
    namestring

    Name of the filter

    Example: Test Filter
    sunsetCommentsRequiredboolean

    Determines if comments on sunset date changes are required.

    Default value: true
    Example: true
    sourceOwnerCampaignInfo objectnullable

    Must be set only if the campaign type is SOURCE_OWNER.

    sourceIdsstring[]

    The list of sources to be included in the campaign.

    Example: ["0fbe863c063c4c88a35fd7f17e8a3df5"]
    searchCampaignInfo objectnullable

    Must be set only if the campaign type is SEARCH.

    typestringrequired

    The type of search campaign represented.

    Possible values: [IDENTITY, ACCESS]

    Example: ACCESS
    descriptionstring

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

    Example: Search Campaign description
    reviewer objectnullable

    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.

    typestring

    The reviewer's DTO type.

    Possible values: [GOVERNANCE_GROUP, IDENTITY]

    Example: IDENTITY
    idstring

    The reviewer's ID.

    Example: 2c91808568c529c60168cca6f90c1313
    namestringnullable

    The reviewer's name.

    Example: William Wilson
    querystringnullable

    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.

    Example: Search Campaign query description
    identityIdsstring[]nullable

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

    Possible values: <= 1000

    Example: ["0fbe863c063c4c88a35fd7f17e8a3df5"]
    accessConstraints object[]

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

    Possible values: <= 1000

  • Array [
    • typestringrequired

    Type of Access

    Possible values: [ENTITLEMENT, ACCESS_PROFILE, ROLE]

    Example: ENTITLEMENT
    idsstring[]

    Must be set only if operator is SELECTED.

    Example: ["2c90ad2a70ace7d50170acf22ca90010"]
    operatorstringrequired

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

    Possible values: [ALL, SELECTED]

    Example: SELECTED
  • ]
    • roleCompositionCampaignInfo objectnullable

    Optional configuration options for role composition campaigns.

    reviewerIdstringnullabledeprecated

    The ID of the identity or governance group reviewing this campaign. Deprecated in favor of the "reviewer" object.

    Example: 2c91808568c529c60168cca6f90c1313
    reviewer objectnullable

    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.

    typestring

    The reviewer's DTO type.

    Possible values: [GOVERNANCE_GROUP, IDENTITY]

    Example: IDENTITY
    idstring

    The reviewer's ID.

    Example: 2c91808568c529c60168cca6f90c1313
    namestring

    The reviewer's name.

    Example: William Wilson
    roleIdsstring[]

    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.

    Example: ["2c90ad2a70ace7d50170acf22ca90010"]
    remediatorRef objectrequired

    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.

    typestringrequired

    Legal Remediator Type

    Possible values: [IDENTITY]

    Example: IDENTITY
    idstringrequired

    The ID of the remediator.

    Example: 2c90ad2a70ace7d50170acf22ca90010
    namestring

    The name of the remediator.

    Example: Role Admin
    querystringnullable

    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.

    Example: Search Query
    descriptionstringnullable

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

    Example: Role Composition Description
    machineAccountCampaignInfo objectnullable

    Must be set only if the campaign type is MACHINE_ACCOUNT.

    sourceIdsstring[]

    The list of sources to be included in the campaign.

    Example: ["0fbe863c063c4c88a35fd7f17e8a3df5"]
    reviewerTypestring

    The reviewer's type.

    Possible values: [ACCOUNT_OWNER]

    Example: ACCOUNT_OWNER
    sourcesWithOrphanEntitlements object[]nullable

    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 [
    • idstring

    Id of the source

    Example: 2c90ad2a70ace7d50170acf22ca90010
    typestring

    Type

    Possible values: [SOURCE]

    Example: SOURCE
    namestring

    Name of the source

    Example: Source with orphan entitlements
  • ]
    • mandatoryCommentRequirementstring

    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.

    Possible values: [ALL_DECISIONS, REVOKE_ONLY_DECISIONS, NO_DECISIONS]

    Example: NO_DECISIONS

Authorization: oauth2

type: Personal Access Token
scopes: idn:campaign-template:read, idn:campaign-template:manage
user levels: ORG_ADMIN, CERT_ADMIN
package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://sailpoint.api.identitynow.com/v2024/campaign-templates/:id"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer <TOKEN>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
Request Collapse all
Base URL
https://sailpoint.api.identitynow.com/v2024
Auth
Parameters
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!