package
1.2.0
Repository: https://github.com/sailpoint-oss/golang-sdk.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

Go API client for beta

Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. 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.

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 beta "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(), beta.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(), beta.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(), beta.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), beta.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/beta

ClassMethodHTTP requestDescription
AccessProfilesApiCreateAccessProfilePost /access-profilesCreate an Access Profile
AccessProfilesApiDeleteAccessProfileDelete /access-profiles/{id}Delete the specified Access Profile
AccessProfilesApiDeleteAccessProfilesInBulkPost /access-profiles/bulk-deleteDelete Access Profile(s)
AccessProfilesApiGetAccessProfileGet /access-profiles/{id}Get an Access Profile
AccessProfilesApiGetAccessProfileEntitlementsGet /access-profiles/{id}/entitlementsList Access Profile's Entitlements
AccessProfilesApiListAccessProfilesGet /access-profilesList Access Profiles
AccessProfilesApiPatchAccessProfilePatch /access-profiles/{id}Patch a specified Access Profile
AccessRequestApprovalsApiApproveAccessRequestPost /access-request-approvals/{approvalId}/approveApproves an access request approval.
AccessRequestApprovalsApiForwardAccessRequestPost /access-request-approvals/{approvalId}/forwardForwards an access request approval to a new owner.
AccessRequestApprovalsApiGetAccessRequestApprovalSummaryGet /access-request-approvals/approval-summaryGet the number of pending, approved and rejected access requests approvals
AccessRequestApprovalsApiListCompletedApprovalsGet /access-request-approvals/completedCompleted Access Request Approvals List
AccessRequestApprovalsApiListPendingApprovalsGet /access-request-approvals/pendingPending Access Request Approvals List
AccessRequestApprovalsApiRejectAccessRequestPost /access-request-approvals/{approvalId}/rejectRejects an access request approval.
AccessRequestsApiCancelAccessRequestPost /access-requests/cancelCancel Access Request
AccessRequestsApiCloseAccessRequestPost /access-requests/closeClose Access Request
AccessRequestsApiCreateAccessRequestPost /access-requestsSubmit an Access Request
AccessRequestsApiGetAccessRequestConfigGet /access-request-configGet Access Request Configuration
AccessRequestsApiListAccessRequestStatusGet /access-request-statusAccess Request Status
AccessRequestsApiSetAccessRequestConfigPut /access-request-configUpdate Access Request Configuration
AccountActivitiesApiGetAccountActivityGet /account-activities/{id}Get Account Activity
AccountActivitiesApiListAccountActivitiesGet /account-activitiesList Account Activities
AccountAggregationsApiGetAccountAggregationStatusGet /account-aggregations/{id}/statusIn-progress Account Aggregation status
AccountUsagesApiGetUsagesByAccountIdGet /account-usages/{accountId}/summariesReturns account usage insights
AccountsApiCreateAccountPost /accountsCreate Account
AccountsApiDeleteAccountDelete /accounts/{id}Delete Account
AccountsApiDisableAccountPost /accounts/{id}/disableDisable Account
AccountsApiDisableAccountForIdentityPost /identities-accounts/{id}/disableDisable IDN Account for Identity
AccountsApiDisableAccountsForIdentitiesPost /identities-accounts/disableDisable IDN Accounts for Identities
AccountsApiEnableAccountPost /accounts/{id}/enableEnable Account
AccountsApiEnableAccountForIdentityPost /identities-accounts/{id}/enableEnable IDN Account for Identity
AccountsApiEnableAccountsForIdentitiesPost /identities-accounts/enableEnable IDN Accounts for Identities
AccountsApiGetAccountGet /accounts/{id}Account Details
AccountsApiGetAccountEntitlementsGet /accounts/{id}/entitlementsAccount Entitlements
AccountsApiListAccountsGet /accountsAccounts List
AccountsApiPutAccountPut /accounts/{id}Update Account
AccountsApiReloadAccountPost /accounts/{id}/reloadReload Account
AccountsApiUnlockAccountPost /accounts/{id}/unlockUnlock Account
AccountsApiUpdateAccountPatch /accounts/{id}Update Account
CertificationCampaignsApiCompleteCampaignPost /campaigns/{id}/completeComplete a Campaign
CertificationCampaignsApiCreateCampaignPost /campaignsCreate a campaign
CertificationCampaignsApiCreateCampaignTemplatePost /campaign-templatesCreate a Campaign Template
CertificationCampaignsApiDeleteCampaignTemplateDelete /campaign-templates/{id}Delete a Campaign Template
CertificationCampaignsApiDeleteCampaignTemplateScheduleDelete /campaign-templates/{id}/scheduleDeletes a Campaign Template's Schedule
CertificationCampaignsApiDeleteCampaignsPost /campaigns/deleteDeletes Campaigns
CertificationCampaignsApiGetActiveCampaignsGet /campaignsList Campaigns
CertificationCampaignsApiGetCampaignGet /campaigns/{id}Get a campaign
CertificationCampaignsApiGetCampaignReportsGet /campaigns/{id}/reportsGet Campaign Reports
CertificationCampaignsApiGetCampaignReportsConfigGet /campaigns/reports-configurationGet Campaign Reports Configuration
CertificationCampaignsApiGetCampaignTemplateGet /campaign-templates/{id}Get a Campaign Template
CertificationCampaignsApiGetCampaignTemplateScheduleGet /campaign-templates/{id}/scheduleGets a Campaign Template's Schedule
CertificationCampaignsApiListCampaignTemplatesGet /campaign-templatesList Campaign Templates
CertificationCampaignsApiMovePost /campaigns/{id}/reassignReassign Certifications
CertificationCampaignsApiPatchCampaignTemplatePatch /campaign-templates/{id}Update a Campaign Template
CertificationCampaignsApiSetCampaignReportsConfigPut /campaigns/reports-configurationSet Campaign Reports Configuration
CertificationCampaignsApiSetCampaignTemplateSchedulePut /campaign-templates/{id}/scheduleSets a Campaign Template's Schedule
CertificationCampaignsApiStartCampaignPost /campaigns/{id}/activateActivate a Campaign
CertificationCampaignsApiStartCampaignRemediationScanPost /campaigns/{id}/run-remediation-scanRun Campaign Remediation Scan
CertificationCampaignsApiStartCampaignReportPost /campaigns/{id}/run-report/{type}Run Campaign Report
CertificationCampaignsApiStartGenerateCampaignTemplatePost /campaign-templates/{id}/generateGenerate a Campaign from Template
CertificationCampaignsApiUpdateCampaignPatch /campaigns/{id}Update a Campaign
CertificationsApiGetIdentityCertificationItemPermissionsGet /certifications/{certificationId}/access-review-items/{itemId}/permissionsPermissions for Entitlement Certification Item
CertificationsApiGetIdentityCertificationPendingTasksGet /certifications/{id}/tasks-pendingPending Certification Tasks
CertificationsApiGetIdentityCertificationTaskStatusGet /certifications/{id}/tasks/{taskId}Certification Task Status
CertificationsApiListCertificationReviewersGet /certifications/{id}/reviewersList of Reviewers for certification
CertificationsApiSubmitReassignCertsAsyncPost /certifications/{id}/reassign-asyncReassign Certifications Asynchronously
ConnectorRuleManagementApiCreateConnectorRulePost /connector-rulesCreate Connector Rule
ConnectorRuleManagementApiDeleteConnectorRuleDelete /connector-rules/{id}Delete a Connector-Rule
ConnectorRuleManagementApiGetConnectorRuleGet /connector-rules/{id}Connector-Rule by ID
ConnectorRuleManagementApiGetConnectorRuleListGet /connector-rulesList Connector Rules
ConnectorRuleManagementApiUpdateConnectorRulePut /connector-rules/{id}Update a Connector Rule
ConnectorRuleManagementApiValidateConnectorRulePost /connector-rules/validateValidate Connector Rule
ConnectorsApiGetConnectorListGet /connectorsGets connector list
CustomFormsApiCreateFormDefinitionPost /form-definitionsCreates a form definition.
CustomFormsApiCreateFormDefinitionDynamicSchemaPost /form-definitions/forms-action-dynamic-schemaGenerate JSON Schema dynamically.
CustomFormsApiCreateFormInstancePost /form-instancesCreates a form instance.
CustomFormsApiDeleteFormDefinitionDelete /form-definitions/{formDefinitionID}Deletes a form definition.
CustomFormsApiExportFormDefinitionsByTenantGet /form-definitions/exportList form definitions by tenant.
CustomFormsApiGetFormDefinitionByKeyGet /form-definitions/{formDefinitionID}Return a form definition.
CustomFormsApiGetFormInstanceByKeyGet /form-instances/{formInstanceID}Returns a form instance.
CustomFormsApiImportFormDefinitionsPost /form-definitions/importImport form definitions from export.
CustomFormsApiPatchFormDefinitionPatch /form-definitions/{formDefinitionID}Patch a form definition.
CustomFormsApiPatchFormInstancePatch /form-instances/{formInstanceID}Patch a form instance.
CustomFormsApiSearchFormDefinitionsByTenantGet /form-definitionsExport form definitions by tenant.
CustomFormsApiSearchFormElementDataByElementIDGet /form-instances/{formInstanceID}/data-source/{formElementID}Retrieves dynamic data by element.
CustomFormsApiSearchFormInstancesByTenantGet /form-instancesList form instances by tenant.
CustomFormsApiSearchPreDefinedSelectOptionsGet /form-definitions/predefined-select-optionsList predefined select options.
CustomFormsApiShowPreviewDataSourcePost /form-definitions/{formDefinitionID}/data-sourcePreview form definition data source.
CustomPasswordInstructionsApiCreateCustomPasswordInstructionsPost /custom-password-instructionsCreate Custom Password Instructions
CustomPasswordInstructionsApiDeleteCustomPasswordInstructionsDelete /custom-password-instructions/{pageId}Delete Custom Password Instructions by page ID
CustomPasswordInstructionsApiGetCustomPasswordInstructionsGet /custom-password-instructions/{pageId}Get Custom Password Instructions by Page ID
EntitlementsApiGetEntitlementGet /entitlements/{id}Get an entitlement
EntitlementsApiGetEntitlementRequestConfigGet /entitlements/{id}/entitlement-request-configGet Entitlement Request Config
EntitlementsApiListEntitlementChildrenGet /entitlements/{id}/childrenList of entitlements children
EntitlementsApiListEntitlementParentsGet /entitlements/{id}/parentsList of entitlements parents
EntitlementsApiListEntitlementsGet /entitlementsGets a list of entitlements.
EntitlementsApiPatchEntitlementPatch /entitlements/{id}Patch an entitlement
EntitlementsApiPutEntitlementRequestConfigPut /entitlements/{id}/entitlement-request-configReplace Entitlement Request Config
EntitlementsApiUpdateEntitlementsInBulkPost /entitlements/bulk-updateBulk update an entitlement list
GovernanceGroupsApiCreateWorkgroupPost /workgroupsCreate a new Governance Group.
GovernanceGroupsApiDeleteWorkgroupDelete /workgroups/{id}Delete a Governance Group
GovernanceGroupsApiDeleteWorkgroupMembersPost /workgroups/{workgroupId}/members/bulk-deleteRemove members from Governance Group
GovernanceGroupsApiDeleteWorkgroupsInBulkPost /workgroups/bulk-deleteDelete Governance Group(s)
GovernanceGroupsApiGetWorkgroupGet /workgroups/{id}Get Governance Group by Id
GovernanceGroupsApiListConnectionsGet /workgroups/{workgroupId}/connectionsList connections for Governance Group
GovernanceGroupsApiListWorkgroupMembersGet /workgroups/{workgroupId}/membersList Governance Group Members
GovernanceGroupsApiListWorkgroupsGet /workgroupsList Governance Groups
GovernanceGroupsApiPatchWorkgroupPatch /workgroups/{id}Patch a Governance Group
GovernanceGroupsApiUpdateWorkgroupMembersPost /workgroups/{workgroupId}/members/bulk-addAdd members to Governance Group
IAIAccessRequestRecommendationsApiAddAccessRequestRecommendationsIgnoredItemPost /ai-access-request-recommendations/ignored-itemsNotification of Ignored Access Request Recommendations
IAIAccessRequestRecommendationsApiAddAccessRequestRecommendationsRequestedItemPost /ai-access-request-recommendations/requested-itemsNotification of Requested Access Request Recommendations
IAIAccessRequestRecommendationsApiAddAccessRequestRecommendationsViewedItemPost /ai-access-request-recommendations/viewed-itemsNotification of Viewed Access Request Recommendations
IAIAccessRequestRecommendationsApiAddAccessRequestRecommendationsViewedItemsPost /ai-access-request-recommendations/viewed-items/bulk-createNotification of Viewed Access Request Recommendations in Bulk
IAIAccessRequestRecommendationsApiGetAccessRequestRecommendationsGet /ai-access-request-recommendationsIdentity Access Request Recommendations
IAIAccessRequestRecommendationsApiGetAccessRequestRecommendationsIgnoredItemsGet /ai-access-request-recommendations/ignored-itemsList of Ignored Access Request Recommendations
IAIAccessRequestRecommendationsApiGetAccessRequestRecommendationsRequestedItemsGet /ai-access-request-recommendations/requested-itemsList of Requested Access Request Recommendations
IAIAccessRequestRecommendationsApiGetAccessRequestRecommendationsViewedItemsGet /ai-access-request-recommendations/viewed-itemsList of Viewed Access Request Recommendations
IAIAccessRequestRecommendationsApiGetMessageCatalogsGet /translation-catalogs/{catalog-id}Get Message catalogs
IAICommonAccessApiCreateCommonAccessPost /common-accessCreate common access items
IAICommonAccessApiGetCommonAccessGet /common-accessGet a paginated list of common access
IAICommonAccessApiUpdateCommonAccessStatusInBulkPost /common-access/update-statusBulk update common access status
IAIOutliersApiExportOutliersZipGet /outliers/exportIAI Identity Outliers Export
IAIOutliersApiGetIdentityOutlierSnapshotsGet /outlier-summariesIAI Identity Outliers Summary
IAIOutliersApiGetIdentityOutliersGet /outliersIAI Get Identity Outliers
IAIOutliersApiGetLatestIdentityOutlierSnapshotsGet /outlier-summaries/latestIAI Identity Outliers Latest Summary
IAIOutliersApiGetOutlierContributingFeatureSummaryGet /outlier-feature-summaries/{outlierFeatureId}Get identity outlier contibuting feature summary
IAIOutliersApiGetPeerGroupOutliersContributingFeaturesGet /outliers/{outlierId}/contributing-featuresGet identity outlier's contibuting features
IAIOutliersApiIgnoreIdentityOutliersPost /outliers/ignoreIAI Identity Outliers Ignore
IAIOutliersApiListOutliersContributingFeatureAccessItemsGet /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-itemsGets a list of access items associated with each identity outlier contributing feature
IAIOutliersApiUnIgnoreIdentityOutliersPost /outliers/unignoreIAI Identity Outliers Unignore
IAIPeerGroupStrategiesApiGetPeerGroupOutliersGet /peer-group-strategies/{strategy}/identity-outliersIdentity Outliers List
IAIRecommendationsApiGetMessageCatalogsGet /translation-catalogs/{catalog-id}Get Message catalogs
IAIRecommendationsApiGetRecommendationsPost /recommendations/requestReturns a Recommendation Based on Object
IAIRecommendationsApiGetRecommendationsConfigGet /recommendations/configGet certification recommendation config values
IAIRecommendationsApiUpdateRecommendationsConfigPut /recommendations/configUpdate certification recommendation config values
IAIRoleMiningApiCreatePotentialRoleProvisionRequestPost /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provisionCreate request to provision a potential role into an actual role.
IAIRoleMiningApiCreateRoleMiningSessionsPost /role-mining-sessionsCreate a role mining session
IAIRoleMiningApiDownloadRoleMiningPotentialRoleZipGet /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/downloadExport (download) details for a potential role in a role mining session
IAIRoleMiningApiExportRoleMiningPotentialRoleGet /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/exportExport (download) details for a potential role in a role mining session
IAIRoleMiningApiExportRoleMiningPotentialRoleAsyncPost /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-asyncAsynchronously export details for a potential role in a role mining session and upload to S3
IAIRoleMiningApiExportRoleMiningPotentialRoleStatusGet /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}Retrieve status of a potential role export job
IAIRoleMiningApiGetAllPotentialRoleSummariesGet /role-mining-potential-rolesRetrieves all potential role summaries
IAIRoleMiningApiGetEntitlementDistributionPotentialRoleGet /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distributionRetrieves entitlement popularity distribution for a potential role in a role mining session
IAIRoleMiningApiGetEntitlementsPotentialRoleGet /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularitiesRetrieves entitlements for a potential role in a role mining session
IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleGet /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlementsRetrieves excluded entitlements for a potential role in a role mining session
IAIRoleMiningApiGetIdentitiesPotentialRoleGet /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identitiesRetrieves identities for a potential role in a role mining session
IAIRoleMiningApiGetPotentialRoleGet /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}Retrieves a specific potential role
IAIRoleMiningApiGetPotentialRoleApplicationsGet /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applicationsRetrieves the applications of a potential role for a role mining session
IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageGet /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsageRetrieves potential role source usage
IAIRoleMiningApiGetPotentialRoleSummariesGet /role-mining-sessions/{sessionId}/potential-role-summariesRetrieves all potential role summaries
IAIRoleMiningApiGetRoleMiningPotentialRoleGet /role-mining-potential-roles/{potentialRoleId}Retrieves a specific potential role
IAIRoleMiningApiGetRoleMiningSessionGet /role-mining-sessions/{sessionId}Get a role mining session
IAIRoleMiningApiGetRoleMiningSessionStatusGet /role-mining-sessions/{sessionId}/statusGet role mining session status state
IAIRoleMiningApiGetRoleMiningSessionsGet /role-mining-sessionsRetrieves all role mining sessions
IAIRoleMiningApiGetSavedPotentialRolesGet /role-mining-potential-roles/savedRetrieves all saved potential roles
IAIRoleMiningApiPatchPotentialRolePatch /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}Update a potential role
IAIRoleMiningApiPatchPotentialRole_0Patch /role-mining-potential-roles/{potentialRoleId}Update a potential role
IAIRoleMiningApiPatchRoleMiningSessionPatch /role-mining-sessions/{sessionId}Patch a role mining session
IAIRoleMiningApiUpdateEntitlementsPotentialRolePost /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlementsEdit entitlements for a potential role to exclude some entitlements
IdentitiesApiDeleteIdentityDelete /identities/{id}Deletes an identity.
IdentitiesApiGetIdentityGet /identities/{id}Identity Details
IdentitiesApiGetIdentityOwnershipDetailsGet /identities/{identityId}/ownershipGet ownership details
IdentitiesApiListIdentitiesGet /identitiesList Identities
IdentitiesApiStartIdentityProcessingPost /identities/processProcess a list of identityIds
IdentitiesApiSynchronizeAttributesForIdentityPost /identities/{identityId}/synchronize-attributesAttribute synchronization for single identity.
IdentityAttributesApiCreateIdentityAttributePost /identity-attributes/{name}Create Identity Attribute
IdentityAttributesApiDeleteIdentityAttributeDelete /identity-attributes/{name}Delete Identity Attribute
IdentityAttributesApiDeleteIdentityAttributesInBulkPost /identity-attributes/bulk-deleteBulk delete Identity Attributes
IdentityAttributesApiGetIdentityAttributeGet /identity-attributes/{name}Get Identity Attribute
IdentityAttributesApiListIdentityAttributesGet /identity-attributesList Identity Attributes
IdentityAttributesApiPutIdentityAttributePut /identity-attributes/{name}Update Identity Attribute
IdentityHistoryApiCompareIdentitySnapshotsGet /historical-identities/{id}/compareGets a difference of count for each access item types for the given identity between 2 snapshots
IdentityHistoryApiCompareIdentitySnapshotsAccessTypeGet /historical-identities/{id}/compare/{access-type}Gets a list of differences of specific accessType for the given identity between 2 snapshots
IdentityHistoryApiGetHistoricalIdentityGet /historical-identities/{id}Get latest snapshot of identity
IdentityHistoryApiGetHistoricalIdentityEventsGet /historical-identities/{id}/eventsLists all events for the given identity
IdentityHistoryApiGetIdentitySnapshotGet /historical-identities/{id}/snapshots/{date}Gets an identity snapshot at a given date
IdentityHistoryApiGetIdentitySnapshotSummaryGet /historical-identities/{id}/snapshot-summaryGets the summary for the event count for a specific identity
IdentityHistoryApiGetIdentityStartDateGet /historical-identities/{id}/start-dateGets the start date of the identity
IdentityHistoryApiListHistoricalIdentitiesGet /historical-identitiesLists all the identities
IdentityHistoryApiListIdentityAccessItemsGet /historical-identities/{id}/access-itemsGets a list of access items for the identity filtered by item type
IdentityHistoryApiListIdentitySnapshotAccessItemsGet /historical-identities/{id}/snapshots/{date}/access-itemsGets the list of identity access items at a given date filterd by item type
IdentityHistoryApiListIdentitySnapshotsGet /historical-identities/{id}/snapshotsLists all the snapshots for the identity
IdentityProfilesApiCreateIdentityProfilePost /identity-profilesCreate an Identity Profile
IdentityProfilesApiDeleteIdentityProfileDelete /identity-profiles/{identity-profile-id}Delete an Identity Profile
IdentityProfilesApiDeleteIdentityProfilesPost /identity-profiles/bulk-deleteDelete Identity Profiles
IdentityProfilesApiExportIdentityProfilesGet /identity-profiles/exportExport Identity Profiles
IdentityProfilesApiGenerateIdentityPreviewPost /identity-profiles/identity-previewGenerate Identity Profile Preview
IdentityProfilesApiGetDefaultIdentityAttributeConfigGet /identity-profiles/{identity-profile-id}/default-identity-attribute-configDefault identity attribute config
IdentityProfilesApiGetIdentityProfileGet /identity-profiles/{identity-profile-id}Gets a single Identity Profile
IdentityProfilesApiImportIdentityProfilesPost /identity-profiles/importImport Identity Profiles
IdentityProfilesApiListIdentityProfilesGet /identity-profilesIdentity Profiles list
IdentityProfilesApiSyncIdentityProfilePost /identity-profiles/{identity-profile-id}/process-identitiesProcess identities under profile
IdentityProfilesApiUpdateIdentityProfilePatch /identity-profiles/{identity-profile-id}Update the Identity Profile
LifecycleStatesApiListLifecycleStatesGet /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}Lifecycle State
LifecycleStatesApiUpdateLifecycleStatesPatch /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}Update Lifecycle State
MFAConfigurationApiDeleteMFAConfigDelete /mfa/{method}/deleteDelete MFA method configuration
MFAConfigurationApiGetMFADuoConfigGet /mfa/duo-web/configConfiguration of Duo MFA method
MFAConfigurationApiGetMFAOktaConfigGet /mfa/okta-verify/configConfiguration of Okta MFA method
MFAConfigurationApiSetMFADuoConfigPut /mfa/duo-web/configSet Duo MFA configuration
MFAConfigurationApiSetMFAOktaConfigPut /mfa/okta-verify/configSet Okta MFA configuration
MFAConfigurationApiTestMFAConfigGet /mfa/{method}/testMFA method's test configuration
ManagedClientsApiGetManagedClientStatusGet /managed-clients/{id}/statusSpecified Managed Client Status.
ManagedClientsApiUpdateManagedClientStatusPost /managed-clients/{id}/statusHandle status request from client
ManagedClustersApiGetClientLogConfigurationGet /managed-clusters/{id}/log-configGet managed cluster's log configuration
ManagedClustersApiGetManagedClusterGet /managed-clusters/{id}Get a specified ManagedCluster.
ManagedClustersApiGetManagedClustersGet /managed-clustersRetrieve all Managed Clusters.
ManagedClustersApiPutClientLogConfigurationPut /managed-clusters/{id}/log-configUpdate managed cluster's log configuration
NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestPost /non-employee-approvals/{id}/approveApprove a Non-Employee Request
NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordPost /non-employee-recordsCreate Non-Employee Record
NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestPost /non-employee-requestsCreate Non-Employee Request
NonEmployeeLifecycleManagementApiCreateNonEmployeeSourcePost /non-employee-sourcesCreate Non-Employee Source
NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesPost /non-employee-sources/{sourceId}/schema-attributesCreate Non-Employee Source Schema Attribute
NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordDelete /non-employee-records/{id}Delete Non-Employee Record
NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordInBulkPost /non-employee-records/bulk-deleteDelete Multiple Non-Employee Records
NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestDelete /non-employee-requests/{id}Delete Non-Employee Request
NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeDelete /non-employee-sources/{sourceId}/schema-attributes/{attributeId}Delete Non-Employee Source's Schema Attribute
NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceDelete /non-employee-sources/{sourceId}Delete Non-Employee Source
NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesDelete /non-employee-sources/{sourceId}/schema-attributesDelete all custom schema attributes
NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsGet /non-employee-sources/{id}/non-employees/downloadExports Non-Employee Records to CSV
NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateGet /non-employee-sources/{id}/schema-attributes-template/downloadExports Source Schema Template
NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalGet /non-employee-approvals/{id}Get a non-employee approval item detail
NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryGet /non-employee-approvals/summary/{requested-for}Get Summary of Non-Employee Approval Requests
NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusGet /non-employee-sources/{id}/non-employee-bulk-upload/statusBulk upload status on source
NonEmployeeLifecycleManagementApiGetNonEmployeeRecordGet /non-employee-records/{id}Get a Non-Employee Record
NonEmployeeLifecycleManagementApiGetNonEmployeeRequestGet /non-employee-requests/{id}Get a Non-Employee Request
NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryGet /non-employee-requests/summary/{requested-for}Get Summary of Non-Employee Requests
NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeGet /non-employee-sources/{sourceId}/schema-attributes/{attributeId}Get Schema Attribute Non-Employee Source
NonEmployeeLifecycleManagementApiGetNonEmployeeSourceGet /non-employee-sources/{sourceId}Get a Non-Employee Source
NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesGet /non-employee-sources/{sourceId}/schema-attributesList Schema Attributes Non-Employee Source
NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkPost /non-employee-sources/{id}/non-employee-bulk-uploadImports, or Updates, Non-Employee Records
NonEmployeeLifecycleManagementApiListNonEmployeeApprovalGet /non-employee-approvalsGet List of Non-Employee Approval Requests
NonEmployeeLifecycleManagementApiListNonEmployeeRecordsGet /non-employee-recordsList Non-Employee Records
NonEmployeeLifecycleManagementApiListNonEmployeeRequestsGet /non-employee-requestsList Non-Employee Requests
NonEmployeeLifecycleManagementApiListNonEmployeeSourcesGet /non-employee-sourcesList Non-Employee Sources
NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordPatch /non-employee-records/{id}Patch Non-Employee Record
NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributePatch /non-employee-sources/{sourceId}/schema-attributes/{attributeId}Patch Non-Employee Source's Schema Attribute
NonEmployeeLifecycleManagementApiPatchNonEmployeeSourcePatch /non-employee-sources/{sourceId}Patch a Non-Employee Source
NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestPost /non-employee-approvals/{id}/rejectReject a Non-Employee Request
NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordPut /non-employee-records/{id}Update Non-Employee Record
NotificationsApiCreateDomainDkimPost /verified-domainsVerify domain address via DKIM
NotificationsApiCreateNotificationTemplatePost /notification-templatesCreate Notification Template
NotificationsApiCreateVerifiedFromAddressPost /verified-from-addressesCreate Verified From Address
NotificationsApiDeleteNotificationTemplatesInBulkPost /notification-templates/bulk-deleteBulk Delete Notification Templates
NotificationsApiDeleteVerifiedFromAddressDelete /verified-from-addresses/{id}Delete Verified From Address
NotificationsApiGetDkimAttributesGet /verified-domainsGet DKIM Attributes
NotificationsApiGetMailFromAttributesGet /mail-from-attributes/{identity}Get MAIL FROM Attributes
NotificationsApiGetNotificationPreferenceGet /notification-preferences/{key}Get Notification Preferences for tenant.
NotificationsApiGetNotificationTemplateGet /notification-templates/{id}Get Notification Template By Id
NotificationsApiGetNotificationsTemplateContextGet /notification-template-contextGet Notification Template Context
NotificationsApiListFromAddressesGet /verified-from-addressesList From Addresses
NotificationsApiListNotificationTemplateDefaultsGet /notification-template-defaultsList Notification Template Defaults
NotificationsApiListNotificationTemplatesGet /notification-templatesList Notification Templates
NotificationsApiPutMailFromAttributesPut /mail-from-attributesChange MAIL FROM domain
NotificationsApiPutNotificationPreferencePut /notification-preferences/{key}Overwrite the preferences for the given notification key.
NotificationsApiSendTestNotificationPost /send-test-notificationSend Test Notification
OAuthClientsApiCreateOauthClientPost /oauth-clientsCreate OAuth Client
OAuthClientsApiDeleteOauthClientDelete /oauth-clients/{id}Delete OAuth Client
OAuthClientsApiGetOauthClientGet /oauth-clients/{id}Get OAuth Client
OAuthClientsApiListOauthClientsGet /oauth-clientsList OAuth Clients
OAuthClientsApiPatchOauthClientPatch /oauth-clients/{id}Patch OAuth Client
OrgConfigApiGetOrgConfigGet /org-configGet Org configuration settings
OrgConfigApiGetValidTimeZonesGet /org-config/valid-time-zonesGet list of time zones
OrgConfigApiPatchOrgConfigPatch /org-configPatch an Org configuration property
PasswordConfigurationApiCreatePasswordOrgConfigPost /password-org-configCreate Password Org Config
PasswordConfigurationApiGetPasswordOrgConfigGet /password-org-configGet Password Org Config
PasswordConfigurationApiPutPasswordOrgConfigPut /password-org-configUpdate Password Org Config
PasswordDictionaryApiGetPasswordDictionaryGet /password-dictionaryGet Password Dictionary
PasswordDictionaryApiUpdatePasswordDictionaryPut /password-dictionaryUpdate Password Dictionary
PasswordManagementApiGenerateDigitTokenPost /generate-password-reset-token/digitGenerate a digit token
PasswordManagementApiGetIdentityPasswordChangeStatusGet /password-change-status/{id}Get Password Change Request Status
PasswordManagementApiQueryPasswordInfoPost /query-password-infoQuery Password Info
PasswordManagementApiSetIdentityPasswordPost /set-passwordSet Identity's Password
PasswordSyncGroupsApiCreatePasswordSyncGroupPost /password-sync-groupsCreate Password Sync Group
PasswordSyncGroupsApiDeletePasswordSyncGroupDelete /password-sync-groups/{id}Delete Password Sync Group by ID
PasswordSyncGroupsApiGetPasswordSyncGroupGet /password-sync-groups/{id}Get Password Sync Group by ID
PasswordSyncGroupsApiGetPasswordSyncGroupsGet /password-sync-groupsGet Password Sync Group List
PasswordSyncGroupsApiUpdatePasswordSyncGroupPut /password-sync-groups/{id}Update Password Sync Group by ID
PersonalAccessTokensApiCreatePersonalAccessTokenPost /personal-access-tokensCreate Personal Access Token
PersonalAccessTokensApiDeletePersonalAccessTokenDelete /personal-access-tokens/{id}Delete Personal Access Token
PersonalAccessTokensApiListPersonalAccessTokensGet /personal-access-tokensList Personal Access Tokens
PersonalAccessTokensApiPatchPersonalAccessTokenPatch /personal-access-tokens/{id}Patch Personal Access Token
PublicIdentitiesConfigApiGetPublicIdentityConfigGet /public-identities-configGet Public Identity Config
PublicIdentitiesConfigApiUpdatePublicIdentityConfigPut /public-identities-configUpdate Public Identity Config
RequestableObjectsApiListRequestableObjectsGet /requestable-objectsRequestable Objects List
RoleInsightsApiCreateRoleInsightRequestsPost /role-insights/requestsGenerate insights for roles
RoleInsightsApiDownloadRoleInsightsEntitlementsChangesGet /role-insights/{insightId}/entitlement-changes/downloadDownload entitlement insights for a role
RoleInsightsApiGetEntitlementChangesIdentitiesGet /role-insights/{insightId}/entitlement-changes/{entitlementId}/identitiesGet identities for a suggested entitlement (for a role)
RoleInsightsApiGetRoleInsightGet /role-insights/{insightId}Get a single role insight
RoleInsightsApiGetRoleInsightsGet /role-insightsGet role insights
RoleInsightsApiGetRoleInsightsCurrentEntitlementsGet /role-insights/{insightId}/current-entitlementsGet current entitlement for a role
RoleInsightsApiGetRoleInsightsEntitlementsChangesGet /role-insights/{insightId}/entitlement-changesGet entitlement insights for a role
RoleInsightsApiGetRoleInsightsRequestsGet /role-insights/requests/{id}Returns metadata from prior request.
RoleInsightsApiGetRoleInsightsSummaryGet /role-insights/summaryGet role insights summary information
RolesApiBulkDeleteRolesPost /roles/bulk-deleteDelete Role(s)
RolesApiCreateRolePost /rolesCreate a Role
RolesApiDeleteRoleDelete /roles/{id}Delete a Role
RolesApiGetRoleGet /roles/{id}Get a Role
RolesApiGetRoleAssignedIdentitiesGet /roles/{id}/assigned-identitiesIdentities assigned a Role
RolesApiListRolesGet /rolesList Roles
RolesApiPatchRolePatch /roles/{id}Patch a specified Role
SODPolicyApiCreateSodPolicyPost /sod-policiesCreate SOD policy
SODPolicyApiDeleteSodPolicyDelete /sod-policies/{id}Delete SOD policy by ID
SODPolicyApiDeleteSodPolicyScheduleDelete /sod-policies/{id}/scheduleDelete SOD policy schedule
SODPolicyApiGetCustomViolationReportGet /sod-violation-report/{reportResultId}/download/{fileName}Download custom violation report
SODPolicyApiGetDefaultViolationReportGet /sod-violation-report/{reportResultId}/downloadDownload violation report
SODPolicyApiGetSodAllReportRunStatusGet /sod-violation-reportGet multi-report run task status
SODPolicyApiGetSodPolicyGet /sod-policies/{id}Get SOD policy by ID
SODPolicyApiGetSodPolicyScheduleGet /sod-policies/{id}/scheduleGet SOD policy schedule
SODPolicyApiGetSodViolationReportRunStatusGet /sod-policies/sod-violation-report-status/{reportResultId}Get violation report run status
SODPolicyApiGetSodViolationReportStatusGet /sod-policies/{id}/violation-reportGet SOD violation report status
SODPolicyApiListSodPoliciesGet /sod-policiesList SOD policies
SODPolicyApiPatchSodPolicyPatch /sod-policies/{id}Patch a SOD policy
SODPolicyApiPutPolicySchedulePut /sod-policies/{id}/scheduleUpdate SOD Policy schedule
SODPolicyApiPutSodPolicyPut /sod-policies/{id}Update SOD policy by ID
SODPolicyApiStartSodAllPoliciesForOrgPost /sod-violation-report/runRuns all policies for org
SODPolicyApiStartSodPolicyPost /sod-policies/{id}/violation-report/runRuns SOD policy violation report
SODViolationsApiStartPredictSodViolationsPost /sod-violations/predictPredict SOD violations for identity.
SPConfigApiExportSpConfigPost /sp-config/exportInitiates configuration objects export job
SPConfigApiGetSpConfigExportGet /sp-config/export/{id}/downloadDownload export job result.
SPConfigApiGetSpConfigExportStatusGet /sp-config/export/{id}Get export job status
SPConfigApiGetSpConfigImportGet /sp-config/import/{id}/downloadDownload import job result
SPConfigApiGetSpConfigImportStatusGet /sp-config/import/{id}Get import job status
SPConfigApiImportSpConfigPost /sp-config/importInitiates configuration objects import job
SPConfigApiListSpConfigObjectsGet /sp-config/config-objectsGet config object details
SearchAttributeConfigurationApiCreateSearchAttributeConfigPost /accounts/search-attribute-configConfigure/create extended search attributes in IdentityNow.
SearchAttributeConfigurationApiDeleteSearchAttributeConfigDelete /accounts/search-attribute-config/{name}Delete an extended search attribute in IdentityNow.
SearchAttributeConfigurationApiGetSearchAttributeConfigGet /accounts/search-attribute-configRetrieve a list of extended search attributes in IdentityNow.
SearchAttributeConfigurationApiGetSingleSearchAttributeConfigGet /accounts/search-attribute-config/{name}Get the details of a specific extended search attribute in IdentityNow.
SearchAttributeConfigurationApiPatchSearchAttributeConfigPatch /accounts/search-attribute-config/{name}Update the details of a specific extended search attribute in IdentityNow.
SegmentsApiCreateSegmentPost /segmentsCreate Segment
SegmentsApiDeleteSegmentDelete /segments/{id}Delete Segment by ID
SegmentsApiGetSegmentGet /segments/{id}Get Segment by ID
SegmentsApiListSegmentsGet /segmentsList Segments
SegmentsApiPatchSegmentPatch /segments/{id}Update Segment
ServiceDeskIntegrationApiCreateServiceDeskIntegrationPost /service-desk-integrationsCreate new Service Desk integration
ServiceDeskIntegrationApiDeleteServiceDeskIntegrationDelete /service-desk-integrations/{id}Delete a Service Desk integration
ServiceDeskIntegrationApiGetServiceDeskIntegrationGet /service-desk-integrations/{id}Get a Service Desk integration
ServiceDeskIntegrationApiGetServiceDeskIntegrationListGet /service-desk-integrationsList existing Service Desk Integrations
ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateGet /service-desk-integrations/templates/{scriptName}Service Desk integration template by scriptName.
ServiceDeskIntegrationApiGetServiceDeskIntegrationTypesGet /service-desk-integrations/typesService Desk Integration Types List.
ServiceDeskIntegrationApiGetStatusCheckDetailsGet /service-desk-integrations/status-check-configurationGet the time check configuration
ServiceDeskIntegrationApiPatchServiceDeskIntegrationPatch /service-desk-integrations/{id}Service Desk Integration Update PATCH
ServiceDeskIntegrationApiPutServiceDeskIntegrationPut /service-desk-integrations/{id}Update a Service Desk integration
ServiceDeskIntegrationApiUpdateStatusCheckDetailsPut /service-desk-integrations/status-check-configurationUpdate the time check configuration
SourceUsagesApiGetStatusBySourceIdGet /source-usages/{sourceId}/statusFinds status of source usage
SourceUsagesApiGetUsagesBySourceIdGet /source-usages/{sourceId}/summariesReturns source usage insights
SourcesApiCreateProvisioningPolicyPost /sources/{sourceId}/provisioning-policiesCreate Provisioning Policy
SourcesApiCreateSourcePost /sourcesCreates a source in IdentityNow.
SourcesApiCreateSourceSchemaPost /sources/{sourceId}/schemasCreates a new Schema on the specified Source in IdentityNow.
SourcesApiDeleteDelete /sources/{id}Delete Source by ID
SourcesApiDeleteNativeChangeDetectionConfigDelete /sources/{sourceId}/native-change-detection-configDelete Native Change Detection Configuration
SourcesApiDeleteProvisioningPolicyDelete /sources/{sourceId}/provisioning-policies/{usageType}Delete Provisioning Policy by UsageType
SourcesApiDeleteSourceSchemaDelete /sources/{sourceId}/schemas/{schemaId}Delete Source Schema by ID
SourcesApiGetNativeChangeDetectionConfigGet /sources/{sourceId}/native-change-detection-configNative Change Detection Configuration
SourcesApiGetProvisioningPolicyGet /sources/{sourceId}/provisioning-policies/{usageType}Get Provisioning Policy by UsageType
SourcesApiGetSourceGet /sources/{id}Get Source by ID
SourcesApiGetSourceAccountsSchemaGet /sources/{id}/schemas/accountsDownloads source accounts schema template
SourcesApiGetSourceAttrSyncConfigGet /sources/{id}/attribute-sync-configAttribute Sync Config
SourcesApiGetSourceConfigGet /sources/{id}/connectors/source-configGets source config with language translations
SourcesApiGetSourceEntitlementRequestConfigGet /sources/{id}/entitlement-request-configGet Source Entitlement Request Configuration
SourcesApiGetSourceEntitlementsSchemaGet /sources/{id}/schemas/entitlementsDownloads source entitlements schema template
SourcesApiGetSourceSchemaGet /sources/{sourceId}/schemas/{schemaId}Get Source Schema by ID
SourcesApiImportSourceAccountsSchemaPost /sources/{id}/schemas/accountsUploads source accounts schema template
SourcesApiImportSourceConnectorFilePost /sources/{sourceId}/upload-connector-fileUpload connector file to source
SourcesApiImportSourceEntitlementsSchemaPost /sources/{id}/schemas/entitlementsUploads source entitlements schema template
SourcesApiListProvisioningPoliciesGet /sources/{sourceId}/provisioning-policiesLists ProvisioningPolicies
SourcesApiListSourceSchemasGet /sources/{sourceId}/schemasLists the Schemas that exist on the specified Source in IdentityNow.
SourcesApiListSourcesGet /sourcesLists all sources in IdentityNow.
SourcesApiPeekResourceObjectsPost /sources/{sourceId}/connector/peek-resource-objectsPeek source connector's resource objects
SourcesApiPingClusterPost /sources/{sourceId}/connector/ping-clusterPing cluster for source connector
SourcesApiPutNativeChangeDetectionConfigPut /sources/{sourceId}/native-change-detection-configUpdate Native Change Detection Configuration
SourcesApiPutProvisioningPolicyPut /sources/{sourceId}/provisioning-policies/{usageType}Update Provisioning Policy by UsageType
SourcesApiPutSourcePut /sources/{id}Update Source (Full)
SourcesApiPutSourceAttrSyncConfigPut /sources/{id}/attribute-sync-configUpdate Attribute Sync Config
SourcesApiPutSourceSchemaPut /sources/{sourceId}/schemas/{schemaId}Update Source Schema (Full)
SourcesApiSyncAttributesForSourcePost /sources/{id}/synchronize-attributesSynchronize single source attributes.
SourcesApiTestSourceConfigurationPost /sources/{sourceId}/connector/test-configurationTest configuration for source connector
SourcesApiTestSourceConnectionPost /sources/{sourceId}/connector/check-connectionCheck connection for source connector.
SourcesApiUpdateProvisioningPoliciesInBulkPost /sources/{sourceId}/provisioning-policies/bulk-updateBulk Update Provisioning Policies
SourcesApiUpdateProvisioningPolicyPatch /sources/{sourceId}/provisioning-policies/{usageType}Partial update of Provisioning Policy
SourcesApiUpdateSourcePatch /sources/{id}Update Source (Partial)
SourcesApiUpdateSourceEntitlementRequestConfigPut /sources/{id}/entitlement-request-configUpdate Source Entitlement Request Configuration
SourcesApiUpdateSourceSchemaPatch /sources/{sourceId}/schemas/{schemaId}Update Source Schema (Partial)
TaggedObjectsApiDeleteTaggedObjectDelete /tagged-objects/{type}/{id}Delete Tagged Object
TaggedObjectsApiDeleteTagsToManyObjectPost /tagged-objects/bulk-removeRemove Tags from Multiple Objects
TaggedObjectsApiGetTaggedObjectGet /tagged-objects/{type}/{id}Get Tagged Object
TaggedObjectsApiListTaggedObjectsGet /tagged-objectsList Tagged Objects
TaggedObjectsApiListTaggedObjectsByTypeGet /tagged-objects/{type}List Tagged Objects
TaggedObjectsApiPutTaggedObjectPut /tagged-objects/{type}/{id}Update Tagged Object
TaggedObjectsApiSetTagToObjectPost /tagged-objectsAdd Tag to Object
TaggedObjectsApiSetTagsToManyObjectsPost /tagged-objects/bulk-addTag Multiple Objects
TaskManagementApiGetPendingTaskHeadersHead /task-status/pending-tasksRetrieve headers only for pending task list.
TaskManagementApiGetPendingTasksGet /task-status/pending-tasksRetrieve a pending task list.
TaskManagementApiGetTaskStatusGet /task-status/{id}Get task status by ID.
TaskManagementApiGetTaskStatusListGet /task-statusRetrieve a task status list.
TaskManagementApiUpdateTaskStatusPatch /task-status/{id}Update task status by ID
TransformsApiCreateTransformPost /transformsCreate transform
TransformsApiDeleteTransformDelete /transforms/{id}Delete a transform
TransformsApiGetTransformGet /transforms/{id}Transform by ID
TransformsApiListTransformsGet /transformsList transforms
TransformsApiUpdateTransformPut /transforms/{id}Update a transform
TriggersApiCompleteTriggerInvocationPost /trigger-invocations/{id}/completeComplete Trigger Invocation
TriggersApiCreateSubscriptionPost /trigger-subscriptionsCreate a Subscription
TriggersApiDeleteSubscriptionDelete /trigger-subscriptions/{id}Delete a Subscription
TriggersApiListSubscriptionsGet /trigger-subscriptionsList Subscriptions
TriggersApiListTriggerInvocationStatusGet /trigger-invocations/statusList Latest Invocation Statuses
TriggersApiListTriggersGet /triggersList Triggers
TriggersApiPatchSubscriptionPatch /trigger-subscriptions/{id}Patch a Subscription
TriggersApiStartTestTriggerInvocationPost /trigger-invocations/testStart a Test Invocation
TriggersApiTestSubscriptionFilterPost /trigger-subscriptions/validate-filterValidate a Subscription Filter
TriggersApiUpdateSubscriptionPut /trigger-subscriptions/{id}Update a Subscription
WorkItemsApiApproveApprovalItemPost /work-items/{id}/approve/{approvalItemId}Approve an Approval Item
WorkItemsApiApproveApprovalItemsInBulkPost /work-items/bulk-approve/{id}Bulk approve Approval Items
WorkItemsApiCompleteWorkItemPost /work-items/{id}Complete a Work Item
WorkItemsApiForwardWorkItemPost /work-items/{id}/forwardForward a Work Item
WorkItemsApiGetCompletedWorkItemsGet /work-items/completedCompleted Work Items
WorkItemsApiGetCountCompletedWorkItemsGet /work-items/count/completedCount Completed Work Items
WorkItemsApiGetCountWorkItemsGet /work-items/countCount Work Items
WorkItemsApiGetWorkItemGet /work-items/{id}Get a Work Item
WorkItemsApiGetWorkItemsSummaryGet /work-items/summaryWork Items Summary
WorkItemsApiListWorkItemsGet /work-itemsList Work Items
WorkItemsApiRejectApprovalItemPost /work-items/{id}/reject/{approvalItemId}Reject an Approval Item
WorkItemsApiRejectApprovalItemsInBulkPost /work-items/bulk-reject/{id}Bulk reject Approval Items
WorkItemsApiSubmitAccountSelectionPost /work-items/{id}/submit-account-selectionSubmit Account Selections
WorkReassignmentApiCreateReassignmentConfigurationPost /reassignment-configurationsCreate a Reassignment Configuration
WorkReassignmentApiDeleteReassignmentConfigurationDelete /reassignment-configurations/{identityId}Delete Reassignment Configuration
WorkReassignmentApiGetEvaluateReassignmentConfigurationGet /reassignment-configurations/{identityId}/evaluate/{configType}Evaluate Reassignment Configuration
WorkReassignmentApiGetReassignmentConfigTypesGet /reassignment-configurations/typesList Reassignment Config Types
WorkReassignmentApiGetReassignmentConfigurationGet /reassignment-configurations/{identityId}Get Reassignment Configuration
WorkReassignmentApiGetTenantConfigConfigurationGet /reassignment-configurations/tenant-configGet Tenant-wide Reassignment Configuration settings
WorkReassignmentApiListReassignmentConfigurationsGet /reassignment-configurationsList Reassignment Configurations
WorkReassignmentApiPutReassignmentConfigPut /reassignment-configurations/{identityId}Update Reassignment Configuration
WorkReassignmentApiPutTenantConfigurationPut /reassignment-configurations/tenant-configUpdate Tenant-wide Reassignment Configuration settings
WorkflowsApiCancelWorkflowExecutionPost /workflow-executions/{id}/cancelCancel Workflow Execution by ID
WorkflowsApiCreateWorkflowPost /workflowsCreate Workflow
WorkflowsApiDeleteWorkflowDelete /workflows/{id}Delete Workflow By Id
WorkflowsApiGetWorkflowGet /workflows/{id}Get Workflow By Id
WorkflowsApiGetWorkflowExecutionGet /workflow-executions/{id}Get a Workflow Execution
WorkflowsApiGetWorkflowExecutionHistoryGet /workflow-executions/{id}/historyGet Workflow Execution History
WorkflowsApiListCompleteWorkflowLibraryGet /workflow-libraryList Complete Workflow Library
WorkflowsApiListWorkflowExecutionsGet /workflows/{id}/executionsList Workflow Executions
WorkflowsApiListWorkflowLibraryActionsGet /workflow-library/actionsList Workflow Library Actions
WorkflowsApiListWorkflowLibraryOperatorsGet /workflow-library/operatorsList Workflow Library Operators
WorkflowsApiListWorkflowLibraryTriggersGet /workflow-library/triggersList Workflow Library Triggers
WorkflowsApiListWorkflowsGet /workflowsList Workflows
WorkflowsApiPatchWorkflowPatch /workflows/{id}Patch Workflow
WorkflowsApiPostExternalExecuteWorkflowPost /workflows/execute/external/{id}Execute Workflow via External Trigger
WorkflowsApiPostWorkflowExternalTriggerPost /workflows/{id}/external/oauth-clientsGenerate External Trigger OAuth Client
WorkflowsApiTestExternalExecuteWorkflowPost /workflows/execute/external/{id}/testTest Workflow via External Trigger
WorkflowsApiTestWorkflowPost /workflows/{id}/testTest Workflow By Id
WorkflowsApiUpdateWorkflowPut /workflows/{id}Update Workflow

Documentation For Models

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

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