Go API client for api_v3

Use these APIs to interact with the Identity Security Cloud 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: 2.1.13
Generator version: 7.8.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 api_v3 "github.com/sailpoint-oss/golang-sdk/v2"

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 api_v3.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), api_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 api_v3.ContextOperationServerIndices and api_v3.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), api_v3.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), api_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 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	Approve Access Request Approval
AccessRequestApprovalsAPI	ForwardAccessRequest	Post /access-request-approvals/{approvalId}/forward	Forward Access Request Approval
AccessRequestApprovalsAPI	GetAccessRequestApprovalSummary	Get /access-request-approvals/approval-summary	Get Access Requests Approvals Number
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	Reject Access Request Approval
AccessRequestsAPI	CancelAccessRequest	Post /access-requests/cancel	Cancel Access Request
AccessRequestsAPI	CreateAccessRequest	Post /access-requests	Submit 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	SubmitReloadAccount	Post /accounts/{id}/reload	Reload Account
AccountsAPI	UnlockAccount	Post /accounts/{id}/unlock	Unlock Account
AccountsAPI	UpdateAccount	Patch /accounts/{id}	Update Account
ApplicationDiscoveryAPI	GetDiscoveredApplications	Get /discovered-applications	Get Discovered Applications for Tenant
ApplicationDiscoveryAPI	GetManualDiscoverApplicationsCsvTemplate	Get /manual-discover-applications-template	Download CSV Template for Discovery
ApplicationDiscoveryAPI	SendManualDiscoverApplicationsCsvTemplate	Post /manual-discover-applications	Upload CSV to Discover Applications
AuthUsersAPI	GetAuthUser	Get /auth-users/{id}	Auth User Details
AuthUsersAPI	PatchAuthUser	Patch /auth-users/{id}	Auth User Update
BrandingAPI	CreateBrandingItem	Post /brandings	Create a branding item
BrandingAPI	DeleteBranding	Delete /brandings/{name}	Delete a branding item
BrandingAPI	GetBranding	Get /brandings/{name}	Get a branding item
BrandingAPI	GetBrandingList	Get /brandings	List of branding items
BrandingAPI	SetBrandingItem	Put /brandings/{name}	Update a branding item
CertificationCampaignFiltersAPI	CreateCampaignFilter	Post /campaign-filters	Create 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	Delete Campaign Template Schedule
CertificationCampaignsAPI	DeleteCampaigns	Post /campaigns/delete	Delete Campaigns
CertificationCampaignsAPI	GetActiveCampaigns	Get /campaigns	List Campaigns
CertificationCampaignsAPI	GetCampaign	Get /campaigns/{id}	Get 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	Get Campaign Template Schedule
CertificationCampaignsAPI	GetCampaignTemplates	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	Set Campaign Template 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	List Identity Campaign Certifications
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
ConfigurationHubAPI	CreateObjectMapping	Post /configuration-hub/object-mappings/{sourceOrg}	Creates an object mapping
ConfigurationHubAPI	CreateObjectMappings	Post /configuration-hub/object-mappings/{sourceOrg}/bulk-create	Bulk creates object mappings
ConfigurationHubAPI	CreateUploadedConfiguration	Post /configuration-hub/backups/uploads	Upload a Configuration
ConfigurationHubAPI	DeleteObjectMapping	Delete /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}	Deletes an object mapping
ConfigurationHubAPI	DeleteUploadedConfiguration	Delete /configuration-hub/backups/uploads/{id}	Delete an Uploaded Configuration
ConfigurationHubAPI	GetObjectMappings	Get /configuration-hub/object-mappings/{sourceOrg}	Gets list of object mappings
ConfigurationHubAPI	GetUploadedConfiguration	Get /configuration-hub/backups/uploads/{id}	Get an Uploaded Configuration
ConfigurationHubAPI	ListUploadedConfigurations	Get /configuration-hub/backups/uploads	List Uploaded Configurations
ConfigurationHubAPI	UpdateObjectMappings	Post /configuration-hub/object-mappings/{sourceOrg}/bulk-patch	Bulk updates object mappings
ConnectorsAPI	CreateCustomConnector	Post /connectors	Create custom connector
ConnectorsAPI	DeleteCustomConnector	Delete /connectors/{scriptName}	Deletes connector by script name
ConnectorsAPI	GetConnector	Get /connectors/{scriptName}	Gets connector by script name
ConnectorsAPI	GetConnectorCorrelationConfig	Get /connectors/{scriptName}/correlation-config
ConnectorsAPI	GetConnectorList	Get /connectors	Gets connector list
ConnectorsAPI	GetConnectorSourceConfig	Get /connectors/{scriptName}/source-config
ConnectorsAPI	GetConnectorSourceTemplate	Get /connectors/{scriptName}/source-template
ConnectorsAPI	GetConnectorTranslations	Get /connectors/{scriptName}/translations/{locale}
ConnectorsAPI	PutCorrelationConfig	Put /connectors/{scriptName}/correlation-config
ConnectorsAPI	PutSourceConfig	Put /connectors/{scriptName}/source-config
ConnectorsAPI	PutSourceTemplate	Put /connectors/{scriptName}/source-template
ConnectorsAPI	PutTranslations	Put /connectors/{scriptName}/translations/{locale}
ConnectorsAPI	UpdateConnector	Patch /connectors/{scriptName}	Update connector by script name
GlobalTenantSecuritySettingsAPI	CreateAuthOrgNetworkConfig	Post /auth-org/network-config	Create security network configuration.
GlobalTenantSecuritySettingsAPI	GetAuthOrgLockoutConfig	Get /auth-org/lockout-config	Get Auth Org Lockout Configuration.
GlobalTenantSecuritySettingsAPI	GetAuthOrgNetworkConfig	Get /auth-org/network-config	Get security network configuration.
GlobalTenantSecuritySettingsAPI	GetAuthOrgServiceProviderConfig	Get /auth-org/service-provider-config	Get Service Provider Configuration.
GlobalTenantSecuritySettingsAPI	GetAuthOrgSessionConfig	Get /auth-org/session-config	Get Auth Org Session Configuration.
GlobalTenantSecuritySettingsAPI	PatchAuthOrgLockoutConfig	Patch /auth-org/lockout-config	Update Auth Org Lockout Configuration
GlobalTenantSecuritySettingsAPI	PatchAuthOrgNetworkConfig	Patch /auth-org/network-config	Update security network configuration.
GlobalTenantSecuritySettingsAPI	PatchAuthOrgServiceProviderConfig	Patch /auth-org/service-provider-config	Update Service Provider Configuration
GlobalTenantSecuritySettingsAPI	PatchAuthOrgSessionConfig	Patch /auth-org/session-config	Update Auth Org Session Configuration
IdentityProfilesAPI	CreateIdentityProfile	Post /identity-profiles	Create an Identity Profile
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	ShowIdentityPreview	Post /identity-profiles/identity-preview	Generate Identity Profile Preview
IdentityProfilesAPI	SyncIdentityProfile	Post /identity-profiles/{identity-profile-id}/process-identities	Process identities under profile
IdentityProfilesAPI	UpdateIdentityProfile	Patch /identity-profiles/{identity-profile-id}	Update the Identity 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
LifecycleStatesAPI	GetLifecycleState	Get /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}	Get Lifecycle State
LifecycleStatesAPI	GetLifecycleStates	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
MFAConfigurationAPI	DeleteMFAConfig	Delete /mfa/{method}/delete	Delete MFA method configuration
MFAConfigurationAPI	GetMFADuoConfig	Get /mfa/duo-web/config	Configuration of Duo MFA method
MFAConfigurationAPI	GetMFAKbaConfig	Get /mfa/kba/config	Configuration of KBA MFA method
MFAConfigurationAPI	GetMFAOktaConfig	Get /mfa/okta-verify/config	Configuration of Okta MFA method
MFAConfigurationAPI	SetMFADuoConfig	Put /mfa/duo-web/config	Set Duo MFA configuration
MFAConfigurationAPI	SetMFAKBAConfig	Post /mfa/kba/config/answers	Set MFA KBA configuration
MFAConfigurationAPI	SetMFAOktaConfig	Put /mfa/okta-verify/config	Set Okta MFA configuration
MFAConfigurationAPI	TestMFAConfig	Get /mfa/{method}/test	MFA method's test configuration
MFAControllerAPI	CreateSendToken	Post /mfa/token/send	Create and send user token
MFAControllerAPI	PingVerificationStatus	Post /mfa/{method}/poll	Polling MFA method by VerificationPollRequest
MFAControllerAPI	SendDuoVerifyRequest	Post /mfa/duo-web/verify	Verifying authentication via Duo method
MFAControllerAPI	SendKbaAnswers	Post /mfa/kba/authenticate	Authenticate KBA provided MFA method
MFAControllerAPI	SendOktaVerifyRequest	Post /mfa/okta-verify/verify	Verifying authentication via Okta method
MFAControllerAPI	SendTokenAuthRequest	Post /mfa/token/authenticate	Authenticate Token provided MFA method
ManagedClientsAPI	CreateManagedClient	Post /managed-clients	Create a new Managed Client
ManagedClientsAPI	DeleteManagedClient	Delete /managed-clients/{id}	Delete a Managed Client
ManagedClientsAPI	GetManagedClient	Get /managed-clients/{id}	Get a Managed Client
ManagedClientsAPI	GetManagedClientStatus	Get /managed-clients/{id}/status	Get Managed Client Status.
ManagedClientsAPI	GetManagedClients	Get /managed-clients	Get Managed Clients
ManagedClientsAPI	UpdateManagedClient	Patch /managed-clients/{id}	Update a Managed Client
ManagedClustersAPI	CreateManagedCluster	Post /managed-clusters	Create a new Managed Cluster
ManagedClustersAPI	DeleteManagedCluster	Delete /managed-clusters/{id}	Delete a Managed Cluster
ManagedClustersAPI	GetClientLogConfiguration	Get /managed-clusters/{id}/log-config	Get managed cluster's log configuration
ManagedClustersAPI	GetManagedCluster	Get /managed-clusters/{id}	Get a specified Managed Cluster.
ManagedClustersAPI	GetManagedClusters	Get /managed-clusters	Retrieve all Managed Clusters.
ManagedClustersAPI	PutClientLogConfiguration	Put /managed-clusters/{id}/log-config	Update managed cluster's log configuration
ManagedClustersAPI	UpdateManagedCluster	Patch /managed-clusters/{id}	Update a Managed Cluster
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	PutPasswordDictionary	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
PasswordPoliciesAPI	CreatePasswordPolicy	Post /password-policies	Create Password Policy
PasswordPoliciesAPI	DeletePasswordPolicy	Delete /password-policies/{id}	Delete Password Policy by ID
PasswordPoliciesAPI	GetPasswordPolicyById	Get /password-policies/{id}	Get Password Policy by ID
PasswordPoliciesAPI	ListPasswordPolicies	Get /password-policies	List Password Policies
PasswordPoliciesAPI	SetPasswordPolicy	Put /password-policies/{id}	Update Password Policy by ID
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
ReportsDataExtractionAPI	CancelReport	Post /reports/{id}/cancel	Cancel Report
ReportsDataExtractionAPI	GetReport	Get /reports/{taskResultId}	Get Report File
ReportsDataExtractionAPI	GetReportResult	Get /reports/{taskResultId}/result	Get Report Result
ReportsDataExtractionAPI	StartReport	Post /reports/run	Run Report
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
SODPoliciesAPI	CreateSodPolicy	Post /sod-policies	Create SOD policy
SODPoliciesAPI	DeleteSodPolicy	Delete /sod-policies/{id}	Delete SOD policy by ID
SODPoliciesAPI	DeleteSodPolicySchedule	Delete /sod-policies/{id}/schedule	Delete SOD policy schedule
SODPoliciesAPI	GetCustomViolationReport	Get /sod-violation-report/{reportResultId}/download/{fileName}	Download custom violation report
SODPoliciesAPI	GetDefaultViolationReport	Get /sod-violation-report/{reportResultId}/download	Download violation report
SODPoliciesAPI	GetSodAllReportRunStatus	Get /sod-violation-report	Get multi-report run task status
SODPoliciesAPI	GetSodPolicy	Get /sod-policies/{id}	Get SOD policy by ID
SODPoliciesAPI	GetSodPolicySchedule	Get /sod-policies/{id}/schedule	Get SOD policy schedule
SODPoliciesAPI	GetSodViolationReportRunStatus	Get /sod-policies/sod-violation-report-status/{reportResultId}	Get violation report run status
SODPoliciesAPI	GetSodViolationReportStatus	Get /sod-policies/{id}/violation-report	Get SOD violation report status
SODPoliciesAPI	ListSodPolicies	Get /sod-policies	List SOD policies
SODPoliciesAPI	PatchSodPolicy	Patch /sod-policies/{id}	Patch SOD policy by ID
SODPoliciesAPI	PutPolicySchedule	Put /sod-policies/{id}/schedule	Update SOD Policy schedule
SODPoliciesAPI	PutSodPolicy	Put /sod-policies/{id}	Update SOD policy by ID
SODPoliciesAPI	StartEvaluateSodPolicy	Post /sod-policies/{id}/evaluate	Evaluate one policy by ID
SODPoliciesAPI	StartSodAllPoliciesForOrg	Post /sod-violation-report/run	Runs all policies for org
SODPoliciesAPI	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	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
SearchAttributeConfigurationAPI	CreateSearchAttributeConfig	Post /accounts/search-attribute-config	Create Extended Search Attributes
SearchAttributeConfigurationAPI	DeleteSearchAttributeConfig	Delete /accounts/search-attribute-config/{name}	Delete Extended Search Attribute
SearchAttributeConfigurationAPI	GetSearchAttributeConfig	Get /accounts/search-attribute-config	List Extended Search Attributes
SearchAttributeConfigurationAPI	GetSingleSearchAttributeConfig	Get /accounts/search-attribute-config/{name}	Get Extended Search Attribute
SearchAttributeConfigurationAPI	PatchSearchAttributeConfig	Patch /accounts/search-attribute-config/{name}	Update Extended Search Attribute
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 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	GetSourceConnections	Get /sources/{sourceId}/connections	Get Source Connections 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	GetSourceSchemas	Get /sources/{sourceId}/schemas	List Schemas on Source
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	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 by Type
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
VendorConnectorMappingsAPI	CreateVendorConnectorMapping	Post /vendor-connector-mappings	Create Vendor Connector Mapping
VendorConnectorMappingsAPI	DeleteVendorConnectorMapping	Delete /vendor-connector-mappings	Delete Vendor Connector Mapping
VendorConnectorMapppingAPI	GetVendorConnectorMappings	Get /vendor-connector-mappings	List Vendor Connector Mappings
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	SendWorkItemForward	Post /work-items/{id}/forward	Forward a Work Item
WorkItemsAPI	SubmitAccountSelection	Post /work-items/{id}/submit-account-selection	Submit Account Selections
WorkflowsAPI	CancelWorkflowExecution	Post /workflow-executions/{id}/cancel	Cancel Workflow Execution by ID
WorkflowsAPI	CreateExternalExecuteWorkflow	Post /workflows/execute/external/{id}	Execute Workflow via External Trigger
WorkflowsAPI	CreateWorkflow	Post /workflows/{id}	Create Workflow
WorkflowsAPI	CreateWorkflowExternalTrigger	Post /workflows/{id}/external/oauth-clients	Generate External Trigger OAuth Client
WorkflowsAPI	DeleteWorkflow	Delete /workflows/{id}	Delete Workflow By Id
WorkflowsAPI	GetWorkflow	Get /workflows/{id}	Get Workflow By Id
WorkflowsAPI	GetWorkflowExecution	Get /workflow-executions/{id}	Get Workflow Execution
WorkflowsAPI	GetWorkflowExecutionHistory	Get /workflow-executions/{id}/history	Get Workflow Execution History
WorkflowsAPI	GetWorkflowExecutions	Get /workflows/{id}/executions	List Workflow Executions
WorkflowsAPI	ListCompleteWorkflowLibrary	Get /workflow-library	List Complete Workflow Library
WorkflowsAPI	ListWorkflowLibraryActions	Get /workflow-library/actions	List Workflow Library Actions
WorkflowsAPI	ListWorkflowLibraryOperators	Get /workflow-library/operators	List Workflow Library Operators
WorkflowsAPI	ListWorkflowLibraryTriggers	Get /workflow-library/triggers	List Workflow Library Triggers
WorkflowsAPI	ListWorkflows	Get /workflows	List Workflows
WorkflowsAPI	PatchWorkflow	Patch /workflows/{id}	Patch Workflow
WorkflowsAPI	PutWorkflow	Put /workflows/{id}	Update Workflow
WorkflowsAPI	TestExternalExecuteWorkflow	Post /workflows/execute/external/{id}/test	Test Workflow via External Trigger
WorkflowsAPI	TestWorkflow	Post /workflows/{id}/test	Test Workflow By Id

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

userAuth

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(), api_v3.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, api_v3.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

userAuth

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

Example

auth := context.WithValue(context.Background(), api_v3.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, api_v3.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

applicationAuth

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(), api_v3.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, api_v3.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

# Packages

# README

Go API client for api_v3

Overview

Installation

Configuration of Server URL

Select Server Configuration

Templated Server URL

URLs Configuration per Operation

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

userAuth

userAuth

applicationAuth

Documentation for Utility Methods

Author