Go API client for v3

Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 3.0.0
• Package version: 1.2.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://developer.sailpoint.com/discuss/api-help

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import v3 "github.com/sailpoint-oss/golang-sdk"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), v3.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), v3.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), v3.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), v3.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://sailpoint.api.identitynow.com/v3

Class	Method	HTTP request	Description
AccessProfilesApi	CreateAccessProfile	Post /access-profiles	Create an Access Profile
AccessProfilesApi	DeleteAccessProfile	Delete /access-profiles/{id}	Delete the specified Access Profile
AccessProfilesApi	DeleteAccessProfilesInBulk	Post /access-profiles/bulk-delete	Delete Access Profile(s)
AccessProfilesApi	GetAccessProfile	Get /access-profiles/{id}	Get an Access Profile
AccessProfilesApi	GetAccessProfileEntitlements	Get /access-profiles/{id}/entitlements	List Access Profile's Entitlements
AccessProfilesApi	ListAccessProfiles	Get /access-profiles	List Access Profiles
AccessProfilesApi	PatchAccessProfile	Patch /access-profiles/{id}	Patch a specified Access Profile
AccessRequestApprovalsApi	ApproveAccessRequest	Post /access-request-approvals/{approvalId}/approve	Approves an access request approval.
AccessRequestApprovalsApi	ForwardAccessRequest	Post /access-request-approvals/{approvalId}/forward	Forwards an access request approval.
AccessRequestApprovalsApi	GetAccessRequestApprovalSummary	Get /access-request-approvals/approval-summary	Get the number of access-requests-approvals
AccessRequestApprovalsApi	ListCompletedApprovals	Get /access-request-approvals/completed	Completed Access Request Approvals List
AccessRequestApprovalsApi	ListPendingApprovals	Get /access-request-approvals/pending	Pending Access Request Approvals List
AccessRequestApprovalsApi	RejectAccessRequest	Post /access-request-approvals/{approvalId}/reject	Rejects an access request approval.
AccessRequestsApi	CancelAccessRequest	Post /access-requests/cancel	Cancel Access Request
AccessRequestsApi	CreateAccessRequest	Post /access-requests	Submit an Access Request
AccessRequestsApi	GetAccessRequestConfig	Get /access-request-config	Get Access Request Configuration
AccessRequestsApi	ListAccessRequestStatus	Get /access-request-status	Access Request Status
AccessRequestsApi	SetAccessRequestConfig	Put /access-request-config	Update Access Request Configuration
AccountActivitiesApi	GetAccountActivity	Get /account-activities/{id}	Get an Account Activity
AccountActivitiesApi	ListAccountActivities	Get /account-activities	List Account Activities
AccountUsagesApi	GetUsagesByAccountId	Get /account-usages/{accountId}/summaries	Returns account usage insights
AccountsApi	CreateAccount	Post /accounts	Create Account
AccountsApi	DeleteAccount	Delete /accounts/{id}	Delete Account
AccountsApi	DisableAccount	Post /accounts/{id}/disable	Disable Account
AccountsApi	EnableAccount	Post /accounts/{id}/enable	Enable Account
AccountsApi	GetAccount	Get /accounts/{id}	Account Details
AccountsApi	GetAccountEntitlements	Get /accounts/{id}/entitlements	Account Entitlements
AccountsApi	ListAccounts	Get /accounts	Accounts List
AccountsApi	PutAccount	Put /accounts/{id}	Update Account
AccountsApi	ReloadAccount	Post /accounts/{id}/reload	Reload Account
AccountsApi	UnlockAccount	Post /accounts/{id}/unlock	Unlock Account
AccountsApi	UpdateAccount	Patch /accounts/{id}	Update Account
AuthUserApi	GetAuthUser	Get /auth-users/{id}	Auth User Details
AuthUserApi	PatchAuthUser	Patch /auth-users/{id}	Auth User Update
CertificationCampaignFiltersApi	CreateCampaignFilter	Post /campaign-filters	Create a Campaign Filter
CertificationCampaignFiltersApi	DeleteCampaignFilters	Post /campaign-filters/delete	Deletes Campaign Filters
CertificationCampaignFiltersApi	GetCampaignFilterById	Get /campaign-filters/{id}	Get Campaign Filter by ID
CertificationCampaignFiltersApi	ListCampaignFilters	Get /campaign-filters	List Campaign Filters
CertificationCampaignFiltersApi	UpdateCampaignFilter	Post /campaign-filters/{id}	Updates a Campaign Filter
CertificationCampaignsApi	CompleteCampaign	Post /campaigns/{id}/complete	Complete a Campaign
CertificationCampaignsApi	CreateCampaign	Post /campaigns	Create a campaign
CertificationCampaignsApi	CreateCampaignTemplate	Post /campaign-templates	Create a Campaign Template
CertificationCampaignsApi	DeleteCampaignTemplate	Delete /campaign-templates/{id}	Delete a Campaign Template
CertificationCampaignsApi	DeleteCampaignTemplateSchedule	Delete /campaign-templates/{id}/schedule	Deletes a Campaign Template's Schedule
CertificationCampaignsApi	DeleteCampaigns	Post /campaigns/delete	Deletes Campaigns
CertificationCampaignsApi	GetActiveCampaigns	Get /campaigns	List Campaigns
CertificationCampaignsApi	GetCampaign	Get /campaigns/{id}	Get a campaign
CertificationCampaignsApi	GetCampaignReports	Get /campaigns/{id}/reports	Get Campaign Reports
CertificationCampaignsApi	GetCampaignReportsConfig	Get /campaigns/reports-configuration	Get Campaign Reports Configuration
CertificationCampaignsApi	GetCampaignTemplate	Get /campaign-templates/{id}	Get a Campaign Template
CertificationCampaignsApi	GetCampaignTemplateSchedule	Get /campaign-templates/{id}/schedule	Gets a Campaign Template's Schedule
CertificationCampaignsApi	ListCampaignTemplates	Get /campaign-templates	List Campaign Templates
CertificationCampaignsApi	Move	Post /campaigns/{id}/reassign	Reassign Certifications
CertificationCampaignsApi	PatchCampaignTemplate	Patch /campaign-templates/{id}	Update a Campaign Template
CertificationCampaignsApi	SetCampaignReportsConfig	Put /campaigns/reports-configuration	Set Campaign Reports Configuration
CertificationCampaignsApi	SetCampaignTemplateSchedule	Put /campaign-templates/{id}/schedule	Sets a Campaign Template's Schedule
CertificationCampaignsApi	StartCampaign	Post /campaigns/{id}/activate	Activate a Campaign
CertificationCampaignsApi	StartCampaignRemediationScan	Post /campaigns/{id}/run-remediation-scan	Run Campaign Remediation Scan
CertificationCampaignsApi	StartCampaignReport	Post /campaigns/{id}/run-report/{type}	Run Campaign Report
CertificationCampaignsApi	StartGenerateCampaignTemplate	Post /campaign-templates/{id}/generate	Generate a Campaign from Template
CertificationCampaignsApi	UpdateCampaign	Patch /campaigns/{id}	Update a Campaign
CertificationSummariesApi	GetIdentityAccessSummaries	Get /certifications/{id}/access-summaries/{type}	Access Summaries
CertificationSummariesApi	GetIdentityDecisionSummary	Get /certifications/{id}/decision-summary	Summary of Certification Decisions
CertificationSummariesApi	GetIdentitySummaries	Get /certifications/{id}/identity-summaries	Identity Summaries for Campaign Certification
CertificationSummariesApi	GetIdentitySummary	Get /certifications/{id}/identity-summaries/{identitySummaryId}	Summary for Identity
CertificationsApi	GetCertificationTask	Get /certification-tasks/{id}	Certification Task by ID
CertificationsApi	GetIdentityCertification	Get /certifications/{id}	Identity Certification by ID
CertificationsApi	GetIdentityCertificationItemPermissions	Get /certifications/{certificationId}/access-review-items/{itemId}/permissions	Permissions for Entitlement Certification Item
CertificationsApi	GetPendingCertificationTasks	Get /certification-tasks	List of Pending Certification Tasks
CertificationsApi	ListCertificationReviewers	Get /certifications/{id}/reviewers	List of Reviewers for certification
CertificationsApi	ListIdentityAccessReviewItems	Get /certifications/{id}/access-review-items	List of Access Review Items
CertificationsApi	ListIdentityCertifications	Get /certifications	Identity Campaign Certifications by IDs
CertificationsApi	MakeIdentityDecision	Post /certifications/{id}/decide	Decide on a Certification Item
CertificationsApi	ReassignIdentityCertifications	Post /certifications/{id}/reassign	Reassign Identities or Items
CertificationsApi	SignOffIdentityCertification	Post /certifications/{id}/sign-off	Finalize Identity Certification Decisions
CertificationsApi	SubmitReassignCertsAsync	Post /certifications/{id}/reassign-async	Reassign Certifications Asynchronously
GlobalTenantSecuritySettingsApi	CreateAuthOrgNetworkConfig	Post /auth-org/network-config	Create security network configuration.
GlobalTenantSecuritySettingsApi	GetAuthOrgNetworkConfig	Get /auth-org/network-config	Get security network configuration.
GlobalTenantSecuritySettingsApi	PatchAuthOrgNetworkConfig	Patch /auth-org/network-config	Update security network configuration.
IdentityProfilesApi	DeleteIdentityProfile	Delete /identity-profiles/{identity-profile-id}	Delete an Identity Profile
IdentityProfilesApi	DeleteIdentityProfiles	Post /identity-profiles/bulk-delete	Delete Identity Profiles
IdentityProfilesApi	ExportIdentityProfiles	Get /identity-profiles/export	Export Identity Profiles
IdentityProfilesApi	GetDefaultIdentityAttributeConfig	Get /identity-profiles/{identity-profile-id}/default-identity-attribute-config	Get default Identity Attribute Config
IdentityProfilesApi	GetIdentityProfile	Get /identity-profiles/{identity-profile-id}	Get single Identity Profile
IdentityProfilesApi	ImportIdentityProfiles	Post /identity-profiles/import	Import Identity Profiles
IdentityProfilesApi	ListIdentityProfiles	Get /identity-profiles	Identity Profiles List
IdentityProfilesApi	SyncIdentityProfile	Post /identity-profiles/{identity-profile-id}/process-identities	Process identities under profile
LifecycleStatesApi	CreateLifecycleState	Post /identity-profiles/{identity-profile-id}/lifecycle-states	Create Lifecycle State
LifecycleStatesApi	DeleteLifecycleState	Delete /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}	Delete Lifecycle State by ID
LifecycleStatesApi	GetLifecycleState	Get /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}	Retrieves Lifecycle State
LifecycleStatesApi	ListLifecycleStates	Get /identity-profiles/{identity-profile-id}/lifecycle-states	Lists LifecycleStates
LifecycleStatesApi	SetLifecycleState	Post /identities/{identity-id}/set-lifecycle-state	Set Lifecycle State
LifecycleStatesApi	UpdateLifecycleStates	Patch /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}	Update Lifecycle State
NonEmployeeLifecycleManagementApi	ApproveNonEmployeeRequest	Post /non-employee-approvals/{id}/approve	Approve a Non-Employee Request
NonEmployeeLifecycleManagementApi	CreateNonEmployeeRecord	Post /non-employee-records	Create Non-Employee Record
NonEmployeeLifecycleManagementApi	CreateNonEmployeeRequest	Post /non-employee-requests	Create Non-Employee Request
NonEmployeeLifecycleManagementApi	CreateNonEmployeeSource	Post /non-employee-sources	Create Non-Employee Source
NonEmployeeLifecycleManagementApi	CreateNonEmployeeSourceSchemaAttributes	Post /non-employee-sources/{sourceId}/schema-attributes	Create a new Schema Attribute for Non-Employee Source
NonEmployeeLifecycleManagementApi	DeleteNonEmployeeRecord	Delete /non-employee-records/{id}	Delete Non-Employee Record
NonEmployeeLifecycleManagementApi	DeleteNonEmployeeRecordsInBulk	Post /non-employee-records/bulk-delete	Delete Multiple Non-Employee Records
NonEmployeeLifecycleManagementApi	DeleteNonEmployeeRequest	Delete /non-employee-requests/{id}	Delete Non-Employee Request
NonEmployeeLifecycleManagementApi	DeleteNonEmployeeSchemaAttribute	Delete /non-employee-sources/{sourceId}/schema-attributes/{attributeId}	Delete a Schema Attribute for Non-Employee Source
NonEmployeeLifecycleManagementApi	DeleteNonEmployeeSource	Delete /non-employee-sources/{sourceId}	Delete Non-Employee Source
NonEmployeeLifecycleManagementApi	DeleteNonEmployeeSourceSchemaAttributes	Delete /non-employee-sources/{sourceId}/schema-attributes	Delete all custom schema attributes for Non-Employee Source
NonEmployeeLifecycleManagementApi	ExportNonEmployeeRecords	Get /non-employee-sources/{id}/non-employees/download	Exports Non-Employee Records to CSV
NonEmployeeLifecycleManagementApi	ExportNonEmployeeSourceSchemaTemplate	Get /non-employee-sources/{id}/schema-attributes-template/download	Exports Source Schema Template
NonEmployeeLifecycleManagementApi	GetNonEmployeeApproval	Get /non-employee-approvals/{id}	Get a non-employee approval item detail
NonEmployeeLifecycleManagementApi	GetNonEmployeeApprovalSummary	Get /non-employee-approvals/summary/{requested-for}	Get Summary of Non-Employee Approval Requests
NonEmployeeLifecycleManagementApi	GetNonEmployeeBulkUploadStatus	Get /non-employee-sources/{id}/non-employee-bulk-upload/status	Obtain the status of bulk upload on the source
NonEmployeeLifecycleManagementApi	GetNonEmployeeRecord	Get /non-employee-records/{id}	Get a Non-Employee Record
NonEmployeeLifecycleManagementApi	GetNonEmployeeRequest	Get /non-employee-requests/{id}	Get a Non-Employee Request
NonEmployeeLifecycleManagementApi	GetNonEmployeeRequestSummary	Get /non-employee-requests/summary/{requested-for}	Get Summary of Non-Employee Requests
NonEmployeeLifecycleManagementApi	GetNonEmployeeSchemaAttribute	Get /non-employee-sources/{sourceId}/schema-attributes/{attributeId}	Get Schema Attribute Non-Employee Source
NonEmployeeLifecycleManagementApi	GetNonEmployeeSource	Get /non-employee-sources/{sourceId}	Get a Non-Employee Source
NonEmployeeLifecycleManagementApi	GetNonEmployeeSourceSchemaAttributes	Get /non-employee-sources/{sourceId}/schema-attributes	List Schema Attributes Non-Employee Source
NonEmployeeLifecycleManagementApi	ImportNonEmployeeRecordsInBulk	Post /non-employee-sources/{id}/non-employee-bulk-upload	Imports, or Updates, Non-Employee Records
NonEmployeeLifecycleManagementApi	ListNonEmployeeApprovals	Get /non-employee-approvals	Get List of Non-Employee Approval Requests
NonEmployeeLifecycleManagementApi	ListNonEmployeeRecords	Get /non-employee-records	List Non-Employee Records
NonEmployeeLifecycleManagementApi	ListNonEmployeeRequests	Get /non-employee-requests	List Non-Employee Requests
NonEmployeeLifecycleManagementApi	ListNonEmployeeSources	Get /non-employee-sources	List Non-Employee Sources
NonEmployeeLifecycleManagementApi	PatchNonEmployeeRecord	Patch /non-employee-records/{id}	Patch Non-Employee Record
NonEmployeeLifecycleManagementApi	PatchNonEmployeeSchemaAttribute	Patch /non-employee-sources/{sourceId}/schema-attributes/{attributeId}	Patch a Schema Attribute for Non-Employee Source
NonEmployeeLifecycleManagementApi	PatchNonEmployeeSource	Patch /non-employee-sources/{sourceId}	Patch a Non-Employee Source
NonEmployeeLifecycleManagementApi	RejectNonEmployeeRequest	Post /non-employee-approvals/{id}/reject	Reject a Non-Employee Request
NonEmployeeLifecycleManagementApi	UpdateNonEmployeeRecord	Put /non-employee-records/{id}	Update Non-Employee Record
OAuthClientsApi	CreateOauthClient	Post /oauth-clients	Create OAuth Client
OAuthClientsApi	DeleteOauthClient	Delete /oauth-clients/{id}	Delete OAuth Client
OAuthClientsApi	GetOauthClient	Get /oauth-clients/{id}	Get OAuth Client
OAuthClientsApi	ListOauthClients	Get /oauth-clients	List OAuth Clients
OAuthClientsApi	PatchOauthClient	Patch /oauth-clients/{id}	Patch OAuth Client
PasswordConfigurationApi	CreatePasswordOrgConfig	Post /password-org-config	Create Password Org Config
PasswordConfigurationApi	GetPasswordOrgConfig	Get /password-org-config	Get Password Org Config
PasswordConfigurationApi	PutPasswordOrgConfig	Put /password-org-config	Update Password Org Config
PasswordDictionaryApi	GetPasswordDictionary	Get /password-dictionary	Get Password Dictionary
PasswordDictionaryApi	UpdatePasswordDictionary	Put /password-dictionary	Update Password Dictionary
PasswordManagementApi	GetPasswordChangeStatus	Get /password-change-status/{id}	Get Password Change Request Status
PasswordManagementApi	QueryPasswordInfo	Post /query-password-info	Query Password Info
PasswordManagementApi	SetPassword	Post /set-password	Set Identity's Password
PasswordSyncGroupsApi	CreatePasswordSyncGroup	Post /password-sync-groups	Create Password Sync Group
PasswordSyncGroupsApi	DeletePasswordSyncGroup	Delete /password-sync-groups/{id}	Delete Password Sync Group by ID
PasswordSyncGroupsApi	GetPasswordSyncGroup	Get /password-sync-groups/{id}	Get Password Sync Group by ID
PasswordSyncGroupsApi	GetPasswordSyncGroups	Get /password-sync-groups	Get Password Sync Group List
PasswordSyncGroupsApi	UpdatePasswordSyncGroup	Put /password-sync-groups/{id}	Update Password Sync Group by ID
PersonalAccessTokensApi	CreatePersonalAccessToken	Post /personal-access-tokens	Create Personal Access Token
PersonalAccessTokensApi	DeletePersonalAccessToken	Delete /personal-access-tokens/{id}	Delete Personal Access Token
PersonalAccessTokensApi	ListPersonalAccessTokens	Get /personal-access-tokens	List Personal Access Tokens
PersonalAccessTokensApi	PatchPersonalAccessToken	Patch /personal-access-tokens/{id}	Patch Personal Access Token
PublicIdentitiesApi	GetPublicIdentities	Get /public-identities	Get a list of public identities
PublicIdentitiesConfigApi	GetPublicIdentityConfig	Get /public-identities-config	Get the Public Identities Configuration
PublicIdentitiesConfigApi	UpdatePublicIdentityConfig	Put /public-identities-config	Update the Public Identities Configuration
RequestableObjectsApi	ListRequestableObjects	Get /requestable-objects	Requestable Objects List
RolesApi	CreateRole	Post /roles	Create a Role
RolesApi	DeleteBulkRoles	Post /roles/bulk-delete	Delete Role(s)
RolesApi	DeleteRole	Delete /roles/{id}	Delete a Role
RolesApi	GetRole	Get /roles/{id}	Get a Role
RolesApi	GetRoleAssignedIdentities	Get /roles/{id}/assigned-identities	List Identities assigned a Role
RolesApi	ListRoles	Get /roles	List Roles
RolesApi	PatchRole	Patch /roles/{id}	Patch a specified Role
SODPolicyApi	CreateSodPolicy	Post /sod-policies	Create SOD policy
SODPolicyApi	DeleteSodPolicy	Delete /sod-policies/{id}	Delete SOD policy by ID
SODPolicyApi	DeleteSodPolicySchedule	Delete /sod-policies/{id}/schedule	Delete SOD policy schedule
SODPolicyApi	GetCustomViolationReport	Get /sod-violation-report/{reportResultId}/download/{fileName}	Download custom violation report
SODPolicyApi	GetDefaultViolationReport	Get /sod-violation-report/{reportResultId}/download	Download violation report
SODPolicyApi	GetSodAllReportRunStatus	Get /sod-violation-report	Get multi-report run task status
SODPolicyApi	GetSodPolicy	Get /sod-policies/{id}	Get SOD policy by ID
SODPolicyApi	GetSodPolicySchedule	Get /sod-policies/{id}/schedule	Get SOD policy schedule
SODPolicyApi	GetSodViolationReportRunStatus	Get /sod-policies/sod-violation-report-status/{reportResultId}	Get violation report run status
SODPolicyApi	GetSodViolationReportStatus	Get /sod-policies/{id}/violation-report	Get SOD violation report status
SODPolicyApi	ListSodPolicies	Get /sod-policies	List SOD policies
SODPolicyApi	PatchSodPolicy	Patch /sod-policies/{id}	Patch SOD policy by ID
SODPolicyApi	PutPolicySchedule	Put /sod-policies/{id}/schedule	Update SOD Policy schedule
SODPolicyApi	PutSodPolicy	Put /sod-policies/{id}	Update SOD policy by ID
SODPolicyApi	StartEvaluateSodPolicy	Post /sod-policies/{id}/evaluate	Evaluate one policy by ID
SODPolicyApi	StartSodAllPoliciesForOrg	Post /sod-violation-report/run	Runs all policies for org
SODPolicyApi	StartSodPolicy	Post /sod-policies/{id}/violation-report/run	Runs SOD policy violation report
SODViolationsApi	StartPredictSodViolations	Post /sod-violations/predict	Predict SOD violations for identity.
SODViolationsApi	StartViolationCheck	Post /sod-violations/check	Check SOD violations
SavedSearchApi	CreateSavedSearch	Post /saved-searches	Create a saved search
SavedSearchApi	DeleteSavedSearch	Delete /saved-searches/{id}	Delete document by ID
SavedSearchApi	ExecuteSavedSearch	Post /saved-searches/{id}/execute	Execute a saved search by ID
SavedSearchApi	GetSavedSearch	Get /saved-searches/{id}	Return saved search by ID
SavedSearchApi	ListSavedSearches	Get /saved-searches	Return a list of Saved Searches
SavedSearchApi	PutSavedSearch	Put /saved-searches/{id}	Updates an existing saved search
ScheduledSearchApi	CreateScheduledSearch	Post /scheduled-searches	Create a new scheduled search
ScheduledSearchApi	DeleteScheduledSearch	Delete /scheduled-searches/{id}	Delete a Scheduled Search
ScheduledSearchApi	GetScheduledSearch	Get /scheduled-searches/{id}	Get a Scheduled Search
ScheduledSearchApi	ListScheduledSearch	Get /scheduled-searches	List scheduled searches
ScheduledSearchApi	UnsubscribeScheduledSearch	Post /scheduled-searches/{id}/unsubscribe	Unsubscribe a recipient from Scheduled Search
ScheduledSearchApi	UpdateScheduledSearch	Put /scheduled-searches/{id}	Update an existing Scheduled Search
SearchApi	SearchAggregate	Post /search/aggregate	Perform a Search Query Aggregation
SearchApi	SearchCount	Post /search/count	Count Documents Satisfying a Query
SearchApi	SearchGet	Get /search/{index}/{id}	Get a Document by ID
SearchApi	SearchPost	Post /search	Perform Search
SegmentsApi	CreateSegment	Post /segments	Create Segment
SegmentsApi	DeleteSegment	Delete /segments/{id}	Delete Segment by ID
SegmentsApi	GetSegment	Get /segments/{id}	Get Segment by ID
SegmentsApi	ListSegments	Get /segments	List Segments
SegmentsApi	PatchSegment	Patch /segments/{id}	Update Segment
ServiceDeskIntegrationApi	CreateServiceDeskIntegration	Post /service-desk-integrations	Create new Service Desk integration
ServiceDeskIntegrationApi	DeleteServiceDeskIntegration	Delete /service-desk-integrations/{id}	Delete a Service Desk integration
ServiceDeskIntegrationApi	GetServiceDeskIntegration	Get /service-desk-integrations/{id}	Get a Service Desk integration
ServiceDeskIntegrationApi	GetServiceDeskIntegrationTemplate	Get /service-desk-integrations/templates/{scriptName}	Service Desk integration template by scriptName.
ServiceDeskIntegrationApi	GetServiceDeskIntegrationTypes	Get /service-desk-integrations/types	Service Desk Integration Types List.
ServiceDeskIntegrationApi	GetServiceDeskIntegrations	Get /service-desk-integrations	List existing Service Desk Integrations
ServiceDeskIntegrationApi	GetStatusCheckDetails	Get /service-desk-integrations/status-check-configuration	Get the time check configuration
ServiceDeskIntegrationApi	PatchServiceDeskIntegration	Patch /service-desk-integrations/{id}	Service Desk Integration Update PATCH
ServiceDeskIntegrationApi	PutServiceDeskIntegration	Put /service-desk-integrations/{id}	Update a Service Desk integration
ServiceDeskIntegrationApi	UpdateStatusCheckDetails	Put /service-desk-integrations/status-check-configuration	Update the time check configuration
SourceUsagesApi	GetStatusBySourceId	Get /source-usages/{sourceId}/status	Finds status of source usage
SourceUsagesApi	GetUsagesBySourceId	Get /source-usages/{sourceId}/summaries	Returns source usage insights
SourcesApi	CreateProvisioningPolicy	Post /sources/{sourceId}/provisioning-policies	Create Provisioning Policy
SourcesApi	CreateSource	Post /sources	Creates a source in IdentityNow.
SourcesApi	CreateSourceSchema	Post /sources/{sourceId}/schemas	Create Schema on a Source
SourcesApi	DeleteProvisioningPolicy	Delete /sources/{sourceId}/provisioning-policies/{usageType}	Delete Provisioning Policy by UsageType
SourcesApi	DeleteSource	Delete /sources/{id}	Delete Source by ID
SourcesApi	DeleteSourceSchema	Delete /sources/{sourceId}/schemas/{schemaId}	Delete Source Schema by ID
SourcesApi	GetAccountsSchema	Get /sources/{id}/schemas/accounts	Downloads source accounts schema template
SourcesApi	GetEntitlementsSchema	Get /sources/{id}/schemas/entitlements	Downloads source entitlements schema template
SourcesApi	GetProvisioningPolicy	Get /sources/{sourceId}/provisioning-policies/{usageType}	Get Provisioning Policy by UsageType
SourcesApi	GetSource	Get /sources/{id}	Get Source by ID
SourcesApi	GetSourceHealth	Get /sources/{sourceId}/source-health	Fetches source health by id
SourcesApi	GetSourceSchema	Get /sources/{sourceId}/schemas/{schemaId}	Get Source Schema by ID
SourcesApi	ImportAccountsSchema	Post /sources/{id}/schemas/accounts	Uploads source accounts schema template
SourcesApi	ImportConnectorFile	Post /sources/{sourceId}/upload-connector-file	Upload connector file to source
SourcesApi	ImportEntitlementsSchema	Post /sources/{id}/schemas/entitlements	Uploads source entitlements schema template
SourcesApi	ListProvisioningPolicies	Get /sources/{sourceId}/provisioning-policies	Lists ProvisioningPolicies
SourcesApi	ListSourceSchemas	Get /sources/{sourceId}/schemas	List Schemas on a Source
SourcesApi	ListSources	Get /sources	Lists all sources in IdentityNow.
SourcesApi	PutProvisioningPolicy	Put /sources/{sourceId}/provisioning-policies/{usageType}	Update Provisioning Policy by UsageType
SourcesApi	PutSource	Put /sources/{id}	Update Source (Full)
SourcesApi	PutSourceSchema	Put /sources/{sourceId}/schemas/{schemaId}	Update Source Schema (Full)
SourcesApi	UpdateProvisioningPoliciesInBulk	Post /sources/{sourceId}/provisioning-policies/bulk-update	Bulk Update Provisioning Policies
SourcesApi	UpdateProvisioningPolicy	Patch /sources/{sourceId}/provisioning-policies/{usageType}	Partial update of Provisioning Policy
SourcesApi	UpdateSource	Patch /sources/{id}	Update Source (Partial)
SourcesApi	UpdateSourceSchema	Patch /sources/{sourceId}/schemas/{schemaId}	Update Source Schema (Partial)
TaggedObjectsApi	DeleteTaggedObject	Delete /tagged-objects/{type}/{id}	Delete Tagged Object
TaggedObjectsApi	DeleteTagsToManyObject	Post /tagged-objects/bulk-remove	Remove Tags from Multiple Objects
TaggedObjectsApi	GetTaggedObject	Get /tagged-objects/{type}/{id}	Get Tagged Object
TaggedObjectsApi	ListTaggedObjects	Get /tagged-objects	List Tagged Objects
TaggedObjectsApi	ListTaggedObjectsByType	Get /tagged-objects/{type}	List Tagged Objects
TaggedObjectsApi	PutTaggedObject	Put /tagged-objects/{type}/{id}	Update Tagged Object
TaggedObjectsApi	SetTagToObject	Post /tagged-objects	Add Tag to Object
TaggedObjectsApi	SetTagsToManyObjects	Post /tagged-objects/bulk-add	Tag Multiple Objects
TransformsApi	CreateTransform	Post /transforms	Create transform
TransformsApi	DeleteTransform	Delete /transforms/{id}	Delete a transform
TransformsApi	GetTransform	Get /transforms/{id}	Transform by ID
TransformsApi	ListTransforms	Get /transforms	List transforms
TransformsApi	UpdateTransform	Put /transforms/{id}	Update a transform
WorkItemsApi	ApproveApprovalItem	Post /work-items/{id}/approve/{approvalItemId}	Approve an Approval Item
WorkItemsApi	ApproveApprovalItemsInBulk	Post /work-items/bulk-approve/{id}	Bulk approve Approval Items
WorkItemsApi	CompleteWorkItem	Post /work-items/{id}	Complete a Work Item
WorkItemsApi	GetCompletedWorkItems	Get /work-items/completed	Completed Work Items
WorkItemsApi	GetCountCompletedWorkItems	Get /work-items/completed/count	Count Completed Work Items
WorkItemsApi	GetCountWorkItems	Get /work-items/count	Count Work Items
WorkItemsApi	GetWorkItem	Get /work-items/{id}	Get a Work Item
WorkItemsApi	GetWorkItemsSummary	Get /work-items/summary	Work Items Summary
WorkItemsApi	ListWorkItems	Get /work-items	List Work Items
WorkItemsApi	RejectApprovalItem	Post /work-items/{id}/reject/{approvalItemId}	Reject an Approval Item
WorkItemsApi	RejectApprovalItemsInBulk	Post /work-items/bulk-reject/{id}	Bulk reject Approval Items
WorkItemsApi	SubmitAccountSelection	Post /work-items/{id}/submit-account-selection	Submit Account Selections

Documentation For Models

• Access
• AccessAllOf
• AccessConstraint
• AccessCriteria
• AccessCriteriaCriteriaListInner
• AccessItemRequestedFor
• AccessItemRequester
• AccessItemReviewedBy
• AccessProfile
• AccessProfileApprovalScheme
• AccessProfileBulkDeleteRequest
• AccessProfileBulkDeleteResponse
• AccessProfileDocument
• AccessProfileDocumentAllOf
• AccessProfileEntitlement
• AccessProfileRef
• AccessProfileRole
• AccessProfileSourceRef
• AccessProfileSummary
• AccessProfileSummaryAllOf
• AccessProfileUsage
• AccessProfileUsageUsedByInner
• AccessRequest
• AccessRequestConfig
• AccessRequestItem
• AccessRequestPhases
• AccessRequestType
• AccessReviewItem
• AccessReviewReassignment
• AccessSummary
• AccessSummaryAccess
• AccessType
• Account
• AccountAction
• AccountActivity
• AccountActivityDocument
• AccountActivityItem
• AccountActivityItemOperation
• AccountActivitySearchedItem
• AccountActivitySearchedItemAllOf
• AccountAllOf
• AccountAttributes
• AccountAttributesCreate
• AccountAttributesCreateAttributes
• AccountDocument
• AccountDocumentAllOf
• AccountRequest
• AccountRequestInfo
• AccountRequestResult
• AccountSource
• AccountSourceAllOf
• AccountToggleRequest
• AccountUnlockRequest
• AccountUsage
• AccountsAsyncResult
• ActivateCampaignOptions
• AdminReviewReassign
• AdminReviewReassignReassignTo
• Aggregation
• AggregationAllOf
• AggregationDocument
• AggregationResult
• AggregationType
• Aggregations
• App
• AppAllOf
• AppAllOfAccount
• Approval
• ApprovalComment
• ApprovalForwardHistory
• ApprovalItemDetails
• ApprovalItems
• ApprovalReminderAndEscalationConfig
• ApprovalScheme
• ApprovalSchemeForRole
• ApprovalStatus
• ApprovalStatusDto
• ApprovalStatusDtoOriginalOwner
• ApprovalSummary
• ArrayInner
• AttributeDefinition
• AttributeDefinitionSchema
• AttributeDefinitionType
• AttributeRequest
• AuthUser
• BaseAccess
• BaseAccessAllOf
• BaseAccount
• BaseAccountAllOf
• BaseCommonDto
• BaseDocument
• BaseEntitlement
• BaseEntitlementAllOf
• BeforeProvisioningRuleDto
• Bound
• BucketAggregation
• BucketType
• BulkTaggedObject
• Campaign
• CampaignAlert
• CampaignAllOf
• CampaignAllOfFilter
• CampaignAllOfRoleCompositionCampaignInfo
• CampaignAllOfRoleCompositionCampaignInfoRemediatorRef
• CampaignAllOfSearchCampaignInfo
• CampaignAllOfSearchCampaignInfoReviewer
• CampaignAllOfSourceOwnerCampaignInfo
• CampaignAllOfSourcesWithOrphanEntitlements
• CampaignCompleteOptions
• CampaignFilterDetails
• CampaignFilterDetailsCriteriaListInner
• CampaignReference
• CampaignReport
• CampaignReportAllOf
• CampaignReportsConfig
• CampaignTemplate
• CampaignTemplateOwnerRef
• CampaignsDeleteRequest
• CancelAccessRequest
• CancelledRequestDetails
• Certification
• CertificationDecision
• CertificationIdentitySummary
• CertificationPhase
• CertificationReference
• CertificationTask
• ClientType
• Column
• Comment
• CommentDto
• CommentDtoAuthor
• CompletedApproval
• CompletedApprovalReviewerComment
• CompletedApprovalState
• CompletionStatus
• ConflictingAccessCriteria
• CreateOAuthClientRequest
• CreateOAuthClientResponse
• CreatePersonalAccessTokenRequest
• CreatePersonalAccessTokenResponse
• CreateSavedSearchRequest
• CreateScheduledSearchRequest
• CriteriaType
• DataAccess
• DataAccessCategoriesInner
• DataAccessImpactScore
• DataAccessPoliciesInner
• DeleteNonEmployeeRecordsInBulkRequest
• DeleteSource202Response
• DisplayReference
• DisplayReferenceAllOf
• DocumentType
• DtoType
• EmailNotificationOption
• Entitlement
• EntitlementDocument
• EntitlementDocumentAllOf
• EntitlementDto
• EntitlementDtoAllOf
• EntitlementRef
• EntitlementRequestConfig
• EntitlementSource
• EntitlementSummary
• EntitlementSummaryAllOf
• ErrorMessageDto
• ErrorResponseDto
• Event
• EventAllOf
• EventDocument
• ExceptionAccessCriteria
• ExceptionCriteria
• ExceptionCriteriaAccess
• ExceptionCriteriaCriteriaListInner
• ExecutionStatus
• ExpansionItem
• Expression
• FieldDetailsDto
• Filter
• FilterAggregation
• FilterType
• FormDetails
• FormItemDetails
• ForwardApprovalDto
• GetActiveCampaigns200ResponseInner
• GetOAuthClientResponse
• GetPersonalAccessTokenResponse
• GrantType
• IdentityAccess
• IdentityAttribute
• IdentityAttributeConfig
• IdentityAttributeTransform
• IdentityCertDecisionSummary
• IdentityCertificationDto
• IdentityDocument
• IdentityDocumentAllOf
• IdentityExceptionReportReference
• IdentityProfile
• IdentityProfileAllOf
• IdentityProfileAllOfAuthoritativeSource
• IdentityProfileAllOfOwner
• IdentityProfileExportedObject
• IdentityProfileExportedObjectSelf
• IdentityReference
• IdentityReferenceWithNameAndEmail
• IdentitySummary
• IdentityWithNewAccess
• IdentityWithNewAccess1
• IdentityWithNewAccess1AccessRefsInner
• IdentityWithNewAccessAccessRefsInner
• ImportNonEmployeeRecordsInBulkRequest
• ImportObject
• Index
• InnerHit
• JsonPatch
• JsonPatchOperation
• JsonPatchOperationValue
• LifecycleState
• LifecycleStateAllOf
• LifecyclestateDeleted
• ListAccessProfiles401Response
• ListAccessProfiles429Response
• LocaleOrigin
• ManagerCorrelationMapping
• ManualWorkItemDetails
• ManualWorkItemDetailsCurrentOwner
• ManualWorkItemDetailsOriginalOwner
• ManualWorkItemState
• MetricAggregation
• MetricType
• MultiPolicyRequest
• NameType
• NestedAggregation
• NetworkConfiguration
• NonEmployeeApprovalDecision
• NonEmployeeApprovalItem
• NonEmployeeApprovalItemAllOf
• NonEmployeeApprovalItemBase
• NonEmployeeApprovalItemDetail
• NonEmployeeApprovalItemDetailAllOf
• NonEmployeeApprovalSummary
• NonEmployeeBulkUploadJob
• NonEmployeeBulkUploadStatus
• NonEmployeeIdentityDtoType
• NonEmployeeIdentityReferenceWithId
• NonEmployeeIdnUserRequest
• NonEmployeeRecord
• NonEmployeeRejectApprovalDecision
• NonEmployeeRequest
• NonEmployeeRequestAllOf
• NonEmployeeRequestBody
• NonEmployeeRequestLite
• NonEmployeeRequestSummary
• NonEmployeeRequestWithoutApprovalItem
• NonEmployeeRequestWithoutApprovalItemAllOf
• NonEmployeeSchemaAttribute
• NonEmployeeSchemaAttributeBody
• NonEmployeeSchemaAttributeType
• NonEmployeeSource
• NonEmployeeSourceAllOf
• NonEmployeeSourceLite
• NonEmployeeSourceLiteWithSchemaAttributes
• NonEmployeeSourceLiteWithSchemaAttributesAllOf
• NonEmployeeSourceRequestBody
• NonEmployeeSourceWithCloudExternalId
• NonEmployeeSourceWithCloudExternalIdAllOf
• NonEmployeeSourceWithNECount
• NonEmployeeSourceWithNECountAllOf
• ObjectImportResult
• Operation
• OriginalRequest
• Owner
• OwnerAllOf
• OwnerDto
• OwnerReference
• OwnerReferenceSegments
• Owns
• PasswordChangeRequest
• PasswordChangeResponse
• PasswordInfo
• PasswordInfoAccount
• PasswordInfoQueryDTO
• PasswordOrgConfig
• PasswordStatus
• PasswordSyncGroup
• PatOwner
• PendingApproval
• PendingApprovalAction
• PendingApprovalOwner
• PermissionDto
• PreApprovalTriggerDetails
• ProcessingDetails
• ProvisioningConfig
• ProvisioningConfigManagedResourceRefsInner
• ProvisioningConfigPlanInitializerScript
• ProvisioningCriteriaLevel1
• ProvisioningCriteriaLevel2
• ProvisioningCriteriaLevel3
• ProvisioningCriteriaOperation
• ProvisioningDetails
• ProvisioningPolicy
• ProvisioningPolicyDto
• ProvisioningState
• PublicIdentity
• PublicIdentityAttributeConfig
• PublicIdentityConfig
• Query
• QueryResultFilter
• QueryType
• QueuedCheckConfigDetails
• Range
• ReassignReference
• Reassignment
• ReassignmentReference
• ReassignmentTrailDTO
• ReassignmentType
• Reference
• RemediationItemDetails
• RemediationItems
• ReportResultReference
• ReportResultReferenceAllOf
• ReportType
• RequestOnBehalfOfConfig
• Requestability
• RequestabilityForRole
• RequestableObject
• RequestableObjectReference
• RequestableObjectRequestStatus
• RequestableObjectType
• RequestedItemStatus
• RequestedItemStatusRequestState
• ReviewDecision
• ReviewReassign
• ReviewRecommendation
• ReviewableAccessProfile
• ReviewableEntitlement
• ReviewableEntitlementAccount
• ReviewableRole
• Reviewer
• Revocability
• Role
• RoleAssignmentSourceType
• RoleBulkDeleteRequest
• RoleCriteriaKey
• RoleCriteriaKeyType
• RoleCriteriaLevel1
• RoleCriteriaLevel2
• RoleCriteriaLevel3
• RoleCriteriaOperation
• RoleDocument
• RoleDocumentAllOf
• RoleIdentity
• RoleMembershipIdentity
• RoleMembershipSelector
• RoleMembershipSelectorType
• RoleSummary
• RoleSummaryAllOf
• SavedSearch
• SavedSearchAllOf
• SavedSearchDetail
• SavedSearchDetailFilters
• SavedSearchName
• Schedule
• Schedule1
• Schedule1Days
• Schedule1Hours
• ScheduleDays
• ScheduleHours
• ScheduleMonths
• ScheduleType
• ScheduledSearch
• ScheduledSearchAllOf
• ScheduledSearchAllOfOwner
• ScheduledSearchName
• Schema
• Search
• SearchAggregationSpecification
• SearchAggregationSpecificationAllOf
• SearchArguments
• SearchArgumentsOwner
• SearchFilterType
• SearchIdentityReference
• SearchIdentityReferenceAllOf
• SearchSchedule
• SearchScheduleRecipientsInner
• SectionDetails
• SectionDetailsAllOf
• Segment
• Selector
• SelectorType
• ServiceDeskIntegrationDto
• ServiceDeskIntegrationDtoAllOf
• ServiceDeskIntegrationDtoAllOfOwnerRef
• ServiceDeskIntegrationTemplateDto
• ServiceDeskIntegrationTemplateDtoAllOf
• ServiceDeskIntegrationTemplateType
• ServiceDeskSource
• SetLifecycleState200Response
• SetLifecycleStateRequest
• SlimCampaign
• SodExemptCriteria
• SodPolicy
• SodPolicyConflictingAccessCriteria
• SodPolicyDto
• SodPolicySchedule
• SodRecipient
• SodReportResultDto
• SodViolationCheck
• SodViolationCheckResult
• SodViolationContext
• SodViolationContextCheckCompleted
• SodViolationContextConflictingAccessCriteria
• SodViolationContextConflictingAccessCriteriaLeftCriteria
• Source
• SourceAccountCorrelationConfig
• SourceAccountCorrelationRule
• SourceBeforeProvisioningRule
• SourceCluster
• SourceClusterDto
• SourceFeature
• SourceHealthDto
• SourceManagementWorkgroup
• SourceManagerCorrelationRule
• SourceOwner
• SourcePasswordPoliciesInner
• SourceSchemasInner
• SourceUsage
• SourceUsageStatus
• SpConfigMessage
• SubSearchAggregationSpecification
• SubSearchAggregationSpecificationAllOf
• TaggedObject
• TaggedObjectDto
• TaskResultDto
• TaskResultSimplified
• TextQuery
• Transform
• TransformDefinition
• TransformDefinitionAttributesValue
• TransformRead
• TransformReadAllOf
• TypeAheadQuery
• TypedReference
• UpdatePasswordDictionaryRequest
• UsageType
• Value
• ViolationContext
• ViolationContextPolicy
• ViolationContextPolicyAllOf
• ViolationOwnerAssignmentConfig
• ViolationOwnerAssignmentConfigOwnerRef
• ViolationPrediction
• VisibilityCriteria
• WorkItemState
• WorkItemType
• WorkItems
• WorkItemsCount
• WorkItemsSummary

Documentation For Authorization

ApplicationOnlyAuth

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• sp:scopes:default: default scope

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

UserContextAuth

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• sp:scopes:default: default scope
• sp:scopes:all: access to all scopes

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

UserContextAuth

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://tenant.identitynow.com/oauth/authorize
• Scopes:
• sp:scopes:default: default scope
• sp:scopes:all: access to all scopes

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author