diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccessModelMetadataAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccessModelMetadataAPI.md index 030342909..3b2650e9a 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/AccessModelMetadataAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccessModelMetadataAPI.md @@ -25,14 +25,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-access-model-metadata-attribute**](#get-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute -[**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value -[**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes` | List Access Model Metadata Attributes -[**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values +[**get-access-model-metadata-attribute**](#get-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes/{key}` | Get access model metadata attribute +[**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values/{value}` | Get access model metadata value +[**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes` | List access model metadata attributes +[**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values` | List access model metadata values ## get-access-model-metadata-attribute -Get Access Model Metadata Attribute +Get access model metadata attribute Get single Access Model Metadata Attribute [API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-model-metadata-attribute) @@ -98,7 +98,7 @@ func main() { [[Back to top]](#) ## get-access-model-metadata-attribute-value -Get Access Model Metadata Value +Get access model metadata value Get single Access Model Metadata Attribute Value [API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-model-metadata-attribute-value) @@ -167,7 +167,7 @@ func main() { [[Back to top]](#) ## list-access-model-metadata-attribute -List Access Model Metadata Attributes +List access model metadata attributes Get a list of Access Model Metadata Attributes [API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-model-metadata-attribute) @@ -229,7 +229,7 @@ func main() { [[Back to top]](#) ## list-access-model-metadata-attribute-value -List Access Model Metadata Values +List access model metadata values Get a list of Access Model Metadata Attribute Values [API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-model-metadata-attribute-value) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccessProfilesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccessProfilesAPI.md index b61b70cb6..5d906426e 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/AccessProfilesAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccessProfilesAPI.md @@ -49,18 +49,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-access-profile**](#create-access-profile) | **Post** `/access-profiles` | Create Access Profile -[**delete-access-profile**](#delete-access-profile) | **Delete** `/access-profiles/{id}` | Delete the specified Access Profile -[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-delete` | Delete Access Profile(s) -[**get-access-profile**](#get-access-profile) | **Get** `/access-profiles/{id}` | Get an Access Profile -[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **Get** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements -[**list-access-profiles**](#list-access-profiles) | **Get** `/access-profiles` | List Access Profiles -[**patch-access-profile**](#patch-access-profile) | **Patch** `/access-profiles/{id}` | Patch a specified Access Profile -[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. +[**create-access-profile**](#create-access-profile) | **Post** `/access-profiles` | Create access profile +[**delete-access-profile**](#delete-access-profile) | **Delete** `/access-profiles/{id}` | Delete the specified access profile +[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-delete` | Delete access profile(s) +[**get-access-profile**](#get-access-profile) | **Get** `/access-profiles/{id}` | Get an access profile +[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **Get** `/access-profiles/{id}/entitlements` | List access profile's entitlements +[**list-access-profiles**](#list-access-profiles) | **Get** `/access-profiles` | List access profiles +[**patch-access-profile**](#patch-access-profile) | **Patch** `/access-profiles/{id}` | Patch a specified access profile +[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-update-requestable` | Update access profile(s) requestable field. ## create-access-profile -Create Access Profile +Create access profile Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. @@ -215,7 +215,7 @@ func main() { [[Back to top]](#) ## delete-access-profile -Delete the specified Access Profile +Delete the specified access profile This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. @@ -284,7 +284,7 @@ func main() { [[Back to top]](#) ## delete-access-profiles-in-bulk -Delete Access Profile(s) +Delete access profile(s) This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. @@ -357,7 +357,7 @@ func main() { [[Back to top]](#) ## get-access-profile -Get an Access Profile +Get an access profile This API returns an Access Profile by its ID. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-profile) @@ -423,7 +423,7 @@ func main() { [[Back to top]](#) ## get-access-profile-entitlements -List Access Profile's Entitlements +List access profile's entitlements Use this API to get a list of an access profile's entitlements. A user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. @@ -500,7 +500,7 @@ func main() { [[Back to top]](#) ## list-access-profiles -List Access Profiles +List access profiles Get a list of access profiles. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. @@ -577,7 +577,7 @@ func main() { [[Back to top]](#) ## patch-access-profile -Patch a specified Access Profile +Patch a specified access profile This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. @@ -655,7 +655,7 @@ func main() { [[Back to top]](#) ## update-access-profiles-in-bulk -Update Access Profile(s) requestable field. +Update access profile(s) requestable field. This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestApprovalsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestApprovalsAPI.md index 7f45f0be0..6848f25d3 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestApprovalsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestApprovalsAPI.md @@ -32,16 +32,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-access-request**](#approve-access-request) | **Post** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval -[**forward-access-request**](#forward-access-request) | **Post** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval -[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **Get** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number -[**list-completed-approvals**](#list-completed-approvals) | **Get** `/access-request-approvals/completed` | Completed Access Request Approvals List -[**list-pending-approvals**](#list-pending-approvals) | **Get** `/access-request-approvals/pending` | Pending Access Request Approvals List -[**reject-access-request**](#reject-access-request) | **Post** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval +[**approve-access-request**](#approve-access-request) | **Post** `/access-request-approvals/{approvalId}/approve` | Approve access request approval +[**forward-access-request**](#forward-access-request) | **Post** `/access-request-approvals/{approvalId}/forward` | Forward access request approval +[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **Get** `/access-request-approvals/approval-summary` | Get access requests approvals number +[**list-completed-approvals**](#list-completed-approvals) | **Get** `/access-request-approvals/completed` | Completed access request approvals list +[**list-pending-approvals**](#list-pending-approvals) | **Get** `/access-request-approvals/pending` | Pending access request approvals list +[**reject-access-request**](#reject-access-request) | **Post** `/access-request-approvals/{approvalId}/reject` | Reject access request approval ## approve-access-request -Approve Access Request Approval +Approve access request approval Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. [API Spec](https://developer.sailpoint.com/docs/api/beta/approve-access-request) @@ -122,7 +122,7 @@ func main() { [[Back to top]](#) ## forward-access-request -Forward Access Request Approval +Forward access request approval Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. [API Spec](https://developer.sailpoint.com/docs/api/beta/forward-access-request) @@ -198,7 +198,7 @@ func main() { [[Back to top]](#) ## get-access-request-approval-summary -Get Access Requests Approvals Number +Get access requests approvals number Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-approval-summary) @@ -262,7 +262,7 @@ func main() { [[Back to top]](#) ## list-completed-approvals -Completed Access Request Approvals List +Completed access request approvals list This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-completed-approvals) @@ -334,7 +334,7 @@ func main() { [[Back to top]](#) ## list-pending-approvals -Pending Access Request Approvals List +Pending access request approvals list This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-pending-approvals) @@ -406,7 +406,7 @@ func main() { [[Back to top]](#) ## reject-access-request -Reject Access Request Approval +Reject access request approval Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. [API Spec](https://developer.sailpoint.com/docs/api/beta/reject-access-request) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestsAPI.md index 6891027bc..12d6b2546 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestsAPI.md @@ -30,16 +30,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**cancel-access-request**](#cancel-access-request) | **Post** `/access-requests/cancel` | Cancel Access Request -[**close-access-request**](#close-access-request) | **Post** `/access-requests/close` | Close Access Request -[**create-access-request**](#create-access-request) | **Post** `/access-requests` | Submit Access Request -[**get-access-request-config**](#get-access-request-config) | **Get** `/access-request-config` | Get Access Request Configuration -[**list-access-request-status**](#list-access-request-status) | **Get** `/access-request-status` | Access Request Status -[**set-access-request-config**](#set-access-request-config) | **Put** `/access-request-config` | Update Access Request Configuration +[**cancel-access-request**](#cancel-access-request) | **Post** `/access-requests/cancel` | Cancel access request +[**close-access-request**](#close-access-request) | **Post** `/access-requests/close` | Close access request +[**create-access-request**](#create-access-request) | **Post** `/access-requests` | Submit access request +[**get-access-request-config**](#get-access-request-config) | **Get** `/access-request-config` | Get access request configuration +[**list-access-request-status**](#list-access-request-status) | **Get** `/access-request-status` | Access request status +[**set-access-request-config**](#set-access-request-config) | **Put** `/access-request-config` | Update access request configuration ## cancel-access-request -Cancel Access Request +Cancel access request This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. @@ -110,7 +110,7 @@ func main() { [[Back to top]](#) ## close-access-request -Close Access Request +Close access request This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. @@ -193,7 +193,7 @@ func main() { [[Back to top]](#) ## create-access-request -Submit Access Request +Submit access request Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request @@ -475,7 +475,7 @@ func main() { [[Back to top]](#) ## get-access-request-config -Get Access Request Configuration +Get access request configuration This endpoint returns the current access-request configuration. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-config) @@ -532,7 +532,7 @@ func main() { [[Back to top]](#) ## list-access-request-status -Access Request Status +Access request status Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. @@ -614,7 +614,7 @@ func main() { [[Back to top]](#) ## set-access-request-config -Update Access Request Configuration +Update access request configuration This endpoint replaces the current access-request configuration. [API Spec](https://developer.sailpoint.com/docs/api/beta/set-access-request-config) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccountActivitiesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccountActivitiesAPI.md index 2d244de9d..dd5c2d9b9 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/AccountActivitiesAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccountActivitiesAPI.md @@ -48,12 +48,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-account-activity**](#get-account-activity) | **Get** `/account-activities/{id}` | Get Account Activity -[**list-account-activities**](#list-account-activities) | **Get** `/account-activities` | List Account Activities +[**get-account-activity**](#get-account-activity) | **Get** `/account-activities/{id}` | Get account activity +[**list-account-activities**](#list-account-activities) | **Get** `/account-activities` | List account activities ## get-account-activity -Get Account Activity +Get account activity This gets a single account activity by its id. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-account-activity) @@ -119,7 +119,7 @@ func main() { [[Back to top]](#) ## list-account-activities -List Account Activities +List account activities This gets a collection of account activities that satisfy the given query parameters. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-account-activities) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccountAggregationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccountAggregationsAPI.md index 758120a7c..9646428ca 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/AccountAggregationsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccountAggregationsAPI.md @@ -25,11 +25,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-account-aggregation-status**](#get-account-aggregation-status) | **Get** `/account-aggregations/{id}/status` | In-progress Account Aggregation status +[**get-account-aggregation-status**](#get-account-aggregation-status) | **Get** `/account-aggregations/{id}/status` | In-progress account aggregation status ## get-account-aggregation-status -In-progress Account Aggregation status +In-progress account aggregation status This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccountsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccountsAPI.md index 2438d4c14..2f9da2144 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/AccountsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccountsAPI.md @@ -42,29 +42,29 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-account**](#create-account) | **Post** `/accounts` | Create Account -[**delete-account**](#delete-account) | **Delete** `/accounts/{id}` | Delete Account -[**delete-account-async**](#delete-account-async) | **Post** `/accounts/{id}/remove` | Remove Account -[**disable-account**](#disable-account) | **Post** `/accounts/{id}/disable` | Disable Account -[**disable-account-for-identity**](#disable-account-for-identity) | **Post** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity -[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **Post** `/identities-accounts/disable` | Disable IDN Accounts for Identities -[**enable-account**](#enable-account) | **Post** `/accounts/{id}/enable` | Enable Account -[**enable-account-for-identity**](#enable-account-for-identity) | **Post** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity -[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **Post** `/identities-accounts/enable` | Enable IDN Accounts for Identities -[**get-account**](#get-account) | **Get** `/accounts/{id}` | Account Details -[**get-account-entitlements**](#get-account-entitlements) | **Get** `/accounts/{id}/entitlements` | Account Entitlements -[**list-accounts**](#list-accounts) | **Get** `/accounts` | Accounts List -[**put-account**](#put-account) | **Put** `/accounts/{id}` | Update Account -[**submit-reload-account**](#submit-reload-account) | **Post** `/accounts/{id}/reload` | Reload Account -[**unlock-account**](#unlock-account) | **Post** `/accounts/{id}/unlock` | Unlock Account -[**update-account**](#update-account) | **Patch** `/accounts/{id}` | Update Account +[**create-account**](#create-account) | **Post** `/accounts` | Create account +[**delete-account**](#delete-account) | **Delete** `/accounts/{id}` | Delete account +[**delete-account-async**](#delete-account-async) | **Post** `/accounts/{id}/remove` | Remove account +[**disable-account**](#disable-account) | **Post** `/accounts/{id}/disable` | Disable account +[**disable-account-for-identity**](#disable-account-for-identity) | **Post** `/identities-accounts/{id}/disable` | Disable idn account for identity +[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **Post** `/identities-accounts/disable` | Disable idn accounts for identities +[**enable-account**](#enable-account) | **Post** `/accounts/{id}/enable` | Enable account +[**enable-account-for-identity**](#enable-account-for-identity) | **Post** `/identities-accounts/{id}/enable` | Enable idn account for identity +[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **Post** `/identities-accounts/enable` | Enable idn accounts for identities +[**get-account**](#get-account) | **Get** `/accounts/{id}` | Account details +[**get-account-entitlements**](#get-account-entitlements) | **Get** `/accounts/{id}/entitlements` | Account entitlements +[**list-accounts**](#list-accounts) | **Get** `/accounts` | Accounts list +[**put-account**](#put-account) | **Put** `/accounts/{id}` | Update account +[**submit-reload-account**](#submit-reload-account) | **Post** `/accounts/{id}/reload` | Reload account +[**unlock-account**](#unlock-account) | **Post** `/accounts/{id}/unlock` | Unlock account +[**update-account**](#update-account) | **Patch** `/accounts/{id}` | Update account ## create-account :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Create Account +Create account Submits an account creation task - the API then returns the task ID. The `sourceId` where this account will be created must be included in the `attributes` object. @@ -154,7 +154,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Delete Account +Delete account Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. @@ -224,7 +224,7 @@ func main() { [[Back to top]](#) ## delete-account-async -Remove Account +Remove account Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: @@ -299,7 +299,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Disable Account +Disable account This API submits a task to disable the account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. @@ -379,7 +379,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Disable IDN Account for Identity +Disable idn account for identity This API submits a task to disable IDN account for a single identity. [API Spec](https://developer.sailpoint.com/docs/api/beta/disable-account-for-identity) @@ -448,7 +448,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Disable IDN Accounts for Identities +Disable idn accounts for identities This API submits tasks to disable IDN account for each identity provided in the request body. [API Spec](https://developer.sailpoint.com/docs/api/beta/disable-accounts-for-identities) @@ -520,7 +520,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Enable Account +Enable account This API submits a task to enable account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. @@ -600,7 +600,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Enable IDN Account for Identity +Enable idn account for identity This API submits a task to enable IDN account for a single identity. [API Spec](https://developer.sailpoint.com/docs/api/beta/enable-account-for-identity) @@ -669,7 +669,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Enable IDN Accounts for Identities +Enable idn accounts for identities This API submits tasks to enable IDN account for each identity provided in the request body. [API Spec](https://developer.sailpoint.com/docs/api/beta/enable-accounts-for-identities) @@ -741,7 +741,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Account Details +Account details Use this API to return the details for a single account by its ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. @@ -811,7 +811,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Account Entitlements +Account entitlements This API returns entitlements of the account. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. @@ -887,7 +887,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Accounts List +Accounts list List accounts. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-accounts) @@ -962,7 +962,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Update Account +Update account Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. @@ -1053,7 +1053,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Reload Account +Reload account This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. @@ -1123,7 +1123,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Unlock Account +Unlock account This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. @@ -1205,7 +1205,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Update Account +Update account Use this API to update account details. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ApplicationDiscoveryAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ApplicationDiscoveryAPI.md index 0974e1554..5c1841dc4 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/ApplicationDiscoveryAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ApplicationDiscoveryAPI.md @@ -17,15 +17,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-discovered-application-by-id**](#get-discovered-application-by-id) | **Get** `/discovered-applications/{id}` | Get Discovered Application by ID +[**get-discovered-application-by-id**](#get-discovered-application-by-id) | **Get** `/discovered-applications/{id}` | Get discovered application by id [**get-discovered-applications**](#get-discovered-applications) | **Get** `/discovered-applications` | Retrieve discovered applications for tenant -[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **Get** `/manual-discover-applications-template` | Download CSV Template for Discovery -[**patch-discovered-application-by-id**](#patch-discovered-application-by-id) | **Patch** `/discovered-applications/{id}` | Patch Discovered Application by ID -[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **Post** `/manual-discover-applications` | Upload CSV to Discover Applications +[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **Get** `/manual-discover-applications-template` | Download csv template for discovery +[**patch-discovered-application-by-id**](#patch-discovered-application-by-id) | **Patch** `/discovered-applications/{id}` | Patch discovered application by id +[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **Post** `/manual-discover-applications` | Upload csv to discover applications ## get-discovered-application-by-id -Get Discovered Application by ID +Get discovered application by id Get the discovered application, along with with its associated sources, based on the provided ID. @@ -162,7 +162,7 @@ func main() { [[Back to top]](#) ## get-manual-discover-applications-csv-template -Download CSV Template for Discovery +Download csv template for discovery Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. @@ -222,7 +222,7 @@ func main() { [[Back to top]](#) ## patch-discovered-application-by-id -Patch Discovered Application by ID +Patch discovered application by id Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. You can patch these fields: - **associatedSources** - **dismissed** @@ -290,7 +290,7 @@ func main() { [[Back to top]](#) ## send-manual-discover-applications-csv-template -Upload CSV to Discover Applications +Upload csv to discover applications Upload a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ApprovalsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ApprovalsAPI.md index 267a2cd58..09aef1938 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/ApprovalsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ApprovalsAPI.md @@ -18,12 +18,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-approval**](#get-approval) | **Get** `/generic-approvals/{id}` | Get Approval -[**get-approvals**](#get-approvals) | **Get** `/generic-approvals` | Get Approvals +[**get-approval**](#get-approval) | **Get** `/generic-approvals/{id}` | Get approval +[**get-approvals**](#get-approvals) | **Get** `/generic-approvals` | Get approvals ## get-approval -Get Approval +Get approval Get a single approval for a given approval ID. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and doesn't include access-request-approvals. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-approval) @@ -89,7 +89,7 @@ func main() { [[Back to top]](#) ## get-approvals -Get Approvals +Get approvals Get a list of approvals, which can be filtered by requester ID, status, or reference type. You can use the "Mine" query parameter to return all approvals for the current approver. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals. Absence of all query parameters will will default to mine=true. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AppsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AppsAPI.md index 6aa57225c..b0b355c0d 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/AppsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AppsAPI.md @@ -19,8 +19,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create-source-app**](#create-source-app) | **Post** `/source-apps` | Create source app [**delete-access-profiles-from-source-app-by-bulk**](#delete-access-profiles-from-source-app-by-bulk) | **Post** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app -[**delete-source-app**](#delete-source-app) | **Delete** `/source-apps/{id}` | Delete source app by ID -[**get-source-app**](#get-source-app) | **Get** `/source-apps/{id}` | Get source app by ID +[**delete-source-app**](#delete-source-app) | **Delete** `/source-apps/{id}` | Delete source app by id +[**get-source-app**](#get-source-app) | **Get** `/source-apps/{id}` | Get source app by id [**list-access-profiles-for-source-app**](#list-access-profiles-for-source-app) | **Get** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app [**list-all-source-app**](#list-all-source-app) | **Get** `/source-apps/all` | List all source apps [**list-all-user-apps**](#list-all-user-apps) | **Get** `/user-apps/all` | List all user apps @@ -28,8 +28,8 @@ Method | HTTP request | Description [**list-available-accounts-for-user-app**](#list-available-accounts-for-user-app) | **Get** `/user-apps/{id}/available-accounts` | List available accounts for user app [**list-available-source-apps**](#list-available-source-apps) | **Get** `/source-apps` | List available source apps [**list-owned-user-apps**](#list-owned-user-apps) | **Get** `/user-apps` | List owned user apps -[**patch-source-app**](#patch-source-app) | **Patch** `/source-apps/{id}` | Patch source app by ID -[**patch-user-app**](#patch-user-app) | **Patch** `/user-apps/{id}` | Patch user app by ID +[**patch-source-app**](#patch-source-app) | **Patch** `/source-apps/{id}` | Patch source app by id +[**patch-user-app**](#patch-user-app) | **Patch** `/user-apps/{id}` | Patch user app by id [**update-source-apps-in-bulk**](#update-source-apps-in-bulk) | **Post** `/source-apps/bulk-update` | Bulk update source apps @@ -185,7 +185,7 @@ func main() { [[Back to top]](#) ## delete-source-app -Delete source app by ID +Delete source app by id Use this API to delete a specific source app [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-source-app) @@ -251,7 +251,7 @@ func main() { [[Back to top]](#) ## get-source-app -Get source app by ID +Get source app by id This API returns a source app by its ID. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-app) @@ -810,7 +810,7 @@ func main() { [[Back to top]](#) ## patch-source-app -Patch source app by ID +Patch source app by id This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can't be empty or null. @@ -880,7 +880,7 @@ func main() { [[Back to top]](#) ## patch-user-app -Patch user app by ID +Patch user app by id This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AuthProfileAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AuthProfileAPI.md index a38c93ab5..bfa5f47f3 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/AuthProfileAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AuthProfileAPI.md @@ -21,13 +21,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-profile-config**](#get-profile-config) | **Get** `/auth-profiles/{id}` | Get Auth Profile. -[**get-profile-config-list**](#get-profile-config-list) | **Get** `/auth-profiles` | Get list of Auth Profiles. -[**patch-profile-config**](#patch-profile-config) | **Patch** `/auth-profiles/{id}` | Patch a specified Auth Profile +[**get-profile-config**](#get-profile-config) | **Get** `/auth-profiles/{id}` | Get auth profile. +[**get-profile-config-list**](#get-profile-config-list) | **Get** `/auth-profiles` | Get list of auth profiles. +[**patch-profile-config**](#patch-profile-config) | **Patch** `/auth-profiles/{id}` | Patch a specified auth profile ## get-profile-config -Get Auth Profile. +Get auth profile. This API returns auth profile information. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-profile-config) @@ -93,7 +93,7 @@ func main() { [[Back to top]](#) ## get-profile-config-list -Get list of Auth Profiles. +Get list of auth profiles. This API returns a list of auth profiles. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-profile-config-list) @@ -150,7 +150,7 @@ func main() { [[Back to top]](#) ## patch-profile-config -Patch a specified Auth Profile +Patch a specified auth profile This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/CertificationCampaignsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/CertificationCampaignsAPI.md index fdd553c24..3208f76b3 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/CertificationCampaignsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/CertificationCampaignsAPI.md @@ -80,35 +80,35 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**complete-campaign**](#complete-campaign) | **Post** `/campaigns/{id}/complete` | Complete a Campaign -[**create-campaign**](#create-campaign) | **Post** `/campaigns` | Create Campaign -[**create-campaign-template**](#create-campaign-template) | **Post** `/campaign-templates` | Create a Campaign Template -[**delete-campaign-template**](#delete-campaign-template) | **Delete** `/campaign-templates/{id}` | Delete a Campaign Template -[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **Delete** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule -[**delete-campaigns**](#delete-campaigns) | **Post** `/campaigns/delete` | Delete Campaigns -[**get-active-campaigns**](#get-active-campaigns) | **Get** `/campaigns` | List Campaigns -[**get-campaign**](#get-campaign) | **Get** `/campaigns/{id}` | Get Campaign -[**get-campaign-reports**](#get-campaign-reports) | **Get** `/campaigns/{id}/reports` | Get Campaign Reports -[**get-campaign-reports-config**](#get-campaign-reports-config) | **Get** `/campaigns/reports-configuration` | Get Campaign Reports Configuration -[**get-campaign-template**](#get-campaign-template) | **Get** `/campaign-templates/{id}` | Get a Campaign Template -[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **Get** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule -[**get-campaign-templates**](#get-campaign-templates) | **Get** `/campaign-templates` | List Campaign Templates -[**move**](#move) | **Post** `/campaigns/{id}/reassign` | Reassign Certifications -[**patch-campaign-template**](#patch-campaign-template) | **Patch** `/campaign-templates/{id}` | Update a Campaign Template -[**set-campaign-reports-config**](#set-campaign-reports-config) | **Put** `/campaigns/reports-configuration` | Set Campaign Reports Configuration -[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **Put** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule -[**start-campaign**](#start-campaign) | **Post** `/campaigns/{id}/activate` | Activate a Campaign -[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **Post** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan -[**start-campaign-report**](#start-campaign-report) | **Post** `/campaigns/{id}/run-report/{type}` | Run Campaign Report -[**start-generate-campaign-template**](#start-generate-campaign-template) | **Post** `/campaign-templates/{id}/generate` | Generate a Campaign from Template -[**update-campaign**](#update-campaign) | **Patch** `/campaigns/{id}` | Update a Campaign +[**complete-campaign**](#complete-campaign) | **Post** `/campaigns/{id}/complete` | Complete a campaign +[**create-campaign**](#create-campaign) | **Post** `/campaigns` | Create campaign +[**create-campaign-template**](#create-campaign-template) | **Post** `/campaign-templates` | Create a campaign template +[**delete-campaign-template**](#delete-campaign-template) | **Delete** `/campaign-templates/{id}` | Delete a campaign template +[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **Delete** `/campaign-templates/{id}/schedule` | Delete campaign template schedule +[**delete-campaigns**](#delete-campaigns) | **Post** `/campaigns/delete` | Delete campaigns +[**get-active-campaigns**](#get-active-campaigns) | **Get** `/campaigns` | List campaigns +[**get-campaign**](#get-campaign) | **Get** `/campaigns/{id}` | Get campaign +[**get-campaign-reports**](#get-campaign-reports) | **Get** `/campaigns/{id}/reports` | Get campaign reports +[**get-campaign-reports-config**](#get-campaign-reports-config) | **Get** `/campaigns/reports-configuration` | Get campaign reports configuration +[**get-campaign-template**](#get-campaign-template) | **Get** `/campaign-templates/{id}` | Get a campaign template +[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **Get** `/campaign-templates/{id}/schedule` | Get campaign template schedule +[**get-campaign-templates**](#get-campaign-templates) | **Get** `/campaign-templates` | List campaign templates +[**move**](#move) | **Post** `/campaigns/{id}/reassign` | Reassign certifications +[**patch-campaign-template**](#patch-campaign-template) | **Patch** `/campaign-templates/{id}` | Update a campaign template +[**set-campaign-reports-config**](#set-campaign-reports-config) | **Put** `/campaigns/reports-configuration` | Set campaign reports configuration +[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **Put** `/campaign-templates/{id}/schedule` | Set campaign template schedule +[**start-campaign**](#start-campaign) | **Post** `/campaigns/{id}/activate` | Activate a campaign +[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **Post** `/campaigns/{id}/run-remediation-scan` | Run campaign remediation scan +[**start-campaign-report**](#start-campaign-report) | **Post** `/campaigns/{id}/run-report/{type}` | Run campaign report +[**start-generate-campaign-template**](#start-generate-campaign-template) | **Post** `/campaign-templates/{id}/generate` | Generate a campaign from template +[**update-campaign**](#update-campaign) | **Patch** `/campaigns/{id}` | Update a campaign ## complete-campaign :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Complete a Campaign +Complete a campaign :::caution This endpoint will run successfully for any campaigns that are **past due**. @@ -193,7 +193,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Create Campaign +Create campaign Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. @@ -374,7 +374,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Create a Campaign Template +Create a campaign template Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. @@ -571,7 +571,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Delete a Campaign Template +Delete a campaign template Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. @@ -642,7 +642,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Delete Campaign Template Schedule +Delete campaign template schedule Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. @@ -713,7 +713,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Delete Campaigns +Delete campaigns Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. @@ -788,7 +788,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -List Campaigns +List campaigns Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. @@ -866,7 +866,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Get Campaign +Get campaign Use this API to get information for an existing certification campaign by the campaign's ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. @@ -938,7 +938,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Get Campaign Reports +Get campaign reports Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. @@ -1010,7 +1010,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Get Campaign Reports Configuration +Get campaign reports configuration Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. @@ -1073,7 +1073,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Get a Campaign Template +Get a campaign template Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. @@ -1145,7 +1145,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Get Campaign Template Schedule +Get campaign template schedule Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. @@ -1217,7 +1217,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -List Campaign Templates +List campaign templates Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/list-campaign-templates). The endpoint returns all campaign templates matching the query parameters. @@ -1295,7 +1295,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Reassign Certifications +Reassign certifications This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. @@ -1381,7 +1381,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Update a Campaign Template +Update a campaign template Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. @@ -1460,7 +1460,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Set Campaign Reports Configuration +Set campaign reports configuration Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. @@ -1535,7 +1535,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Set Campaign Template Schedule +Set campaign template schedule Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule). @@ -1628,7 +1628,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Activate a Campaign +Activate a campaign Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. @@ -1704,7 +1704,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Run Campaign Remediation Scan +Run campaign remediation scan Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. @@ -1776,7 +1776,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Run Campaign Report +Run campaign report Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. @@ -1851,7 +1851,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Generate a Campaign from Template +Generate a campaign from template Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description @@ -1935,7 +1935,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Update a Campaign +Update a campaign Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/CertificationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/CertificationsAPI.md index e1ad56b9e..6640c71fb 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/CertificationsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/CertificationsAPI.md @@ -30,19 +30,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **Get** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item -[**get-identity-certification-pending-tasks**](#get-identity-certification-pending-tasks) | **Get** `/certifications/{id}/tasks-pending` | Pending Certification Tasks -[**get-identity-certification-task-status**](#get-identity-certification-task-status) | **Get** `/certifications/{id}/tasks/{taskId}` | Certification Task Status -[**list-certification-reviewers**](#list-certification-reviewers) | **Get** `/certifications/{id}/reviewers` | List of Reviewers for certification -[**list-certifications**](#list-certifications) | **Get** `/certifications` | Certifications by IDs -[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **Post** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously +[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **Get** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for entitlement certification item +[**get-identity-certification-pending-tasks**](#get-identity-certification-pending-tasks) | **Get** `/certifications/{id}/tasks-pending` | Pending certification tasks +[**get-identity-certification-task-status**](#get-identity-certification-task-status) | **Get** `/certifications/{id}/tasks/{taskId}` | Certification task status +[**list-certification-reviewers**](#list-certification-reviewers) | **Get** `/certifications/{id}/reviewers` | List of reviewers for certification +[**list-certifications**](#list-certifications) | **Get** `/certifications` | Certifications by ids +[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **Post** `/certifications/{id}/reassign-async` | Reassign certifications asynchronously ## get-identity-certification-item-permissions :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Permissions for Entitlement Certification Item +Permissions for entitlement certification item This API returns the permissions associated with an entitlement certification item based on the certification item's ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-item-permissions) @@ -119,7 +119,7 @@ func main() { [[Back to top]](#) ## get-identity-certification-pending-tasks -Pending Certification Tasks +Pending certification tasks This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-pending-tasks) @@ -185,7 +185,7 @@ func main() { [[Back to top]](#) ## get-identity-certification-task-status -Certification Task Status +Certification task status This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-task-status) @@ -257,7 +257,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -List of Reviewers for certification +List of reviewers for certification This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-certification-reviewers) @@ -333,7 +333,7 @@ func main() { [[Back to top]](#) ## list-certifications -Certifications by IDs +Certifications by ids This API returns a list of certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-certifications) @@ -408,7 +408,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Reassign Certifications Asynchronously +Reassign certifications asynchronously This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/submit-reassign-certs-async) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorRuleManagementAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorRuleManagementAPI.md index 6c53ab2b5..159788de7 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorRuleManagementAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorRuleManagementAPI.md @@ -21,16 +21,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-connector-rule**](#create-connector-rule) | **Post** `/connector-rules` | Create Connector Rule -[**delete-connector-rule**](#delete-connector-rule) | **Delete** `/connector-rules/{id}` | Delete a Connector-Rule -[**get-connector-rule**](#get-connector-rule) | **Get** `/connector-rules/{id}` | Connector-Rule by ID -[**get-connector-rule-list**](#get-connector-rule-list) | **Get** `/connector-rules` | List Connector Rules -[**update-connector-rule**](#update-connector-rule) | **Put** `/connector-rules/{id}` | Update a Connector Rule -[**validate-connector-rule**](#validate-connector-rule) | **Post** `/connector-rules/validate` | Validate Connector Rule +[**create-connector-rule**](#create-connector-rule) | **Post** `/connector-rules` | Create connector rule +[**delete-connector-rule**](#delete-connector-rule) | **Delete** `/connector-rules/{id}` | Delete a connector-rule +[**get-connector-rule**](#get-connector-rule) | **Get** `/connector-rules/{id}` | Connector-rule by id +[**get-connector-rule-list**](#get-connector-rule-list) | **Get** `/connector-rules` | List connector rules +[**update-connector-rule**](#update-connector-rule) | **Put** `/connector-rules/{id}` | Update a connector rule +[**validate-connector-rule**](#validate-connector-rule) | **Post** `/connector-rules/validate` | Validate connector rule ## create-connector-rule -Create Connector Rule +Create connector rule Creates a new connector rule. A token with ORG_ADMIN authority is required to call this API. @@ -123,7 +123,7 @@ func main() { [[Back to top]](#) ## delete-connector-rule -Delete a Connector-Rule +Delete a connector-rule Deletes the connector rule specified by the given ID. A token with ORG_ADMIN authority is required to call this API. @@ -189,7 +189,7 @@ func main() { [[Back to top]](#) ## get-connector-rule -Connector-Rule by ID +Connector-rule by id Returns the connector rule specified by ID. A token with ORG_ADMIN authority is required to call this API. @@ -256,7 +256,7 @@ func main() { [[Back to top]](#) ## get-connector-rule-list -List Connector Rules +List connector rules Returns the list of connector rules. A token with ORG_ADMIN authority is required to call this API. @@ -314,7 +314,7 @@ func main() { [[Back to top]](#) ## update-connector-rule -Update a Connector Rule +Update a connector rule Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable. A token with ORG_ADMIN authority is required to call this API. @@ -409,7 +409,7 @@ func main() { [[Back to top]](#) ## validate-connector-rule -Validate Connector Rule +Validate connector rule Returns a list of issues within the code to fix, if any. A token with ORG_ADMIN authority is required to call this API. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorsAPI.md index 7179ed298..3309e9f22 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorsAPI.md @@ -29,11 +29,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-connector-list**](#get-connector-list) | **Get** `/connectors` | Get Connector List +[**get-connector-list**](#get-connector-list) | **Get** `/connectors` | Get connector list ## get-connector-list -Get Connector List +Get connector list Fetches list of connectors that have 'RELEASED' status using filtering and pagination. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-list) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/CustomFormsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/CustomFormsAPI.md index 871d6bab3..d26a55065 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/CustomFormsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/CustomFormsAPI.md @@ -25,15 +25,15 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create-form-definition**](#create-form-definition) | **Post** `/form-definitions` | Creates a form definition. [**create-form-definition-by-template**](#create-form-definition-by-template) | **Post** `/form-definitions/template` | Create a form definition by template. -[**create-form-definition-dynamic-schema**](#create-form-definition-dynamic-schema) | **Post** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically. +[**create-form-definition-dynamic-schema**](#create-form-definition-dynamic-schema) | **Post** `/form-definitions/forms-action-dynamic-schema` | Generate json schema dynamically. [**create-form-definition-file-request**](#create-form-definition-file-request) | **Post** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file. [**create-form-instance**](#create-form-instance) | **Post** `/form-instances` | Creates a form instance. [**delete-form-definition**](#delete-form-definition) | **Delete** `/form-definitions/{formDefinitionID}` | Deletes a form definition. [**export-form-definitions-by-tenant**](#export-form-definitions-by-tenant) | **Get** `/form-definitions/export` | List form definitions by tenant. -[**get-file-from-s3**](#get-file-from-s3) | **Get** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId. +[**get-file-from-s3**](#get-file-from-s3) | **Get** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileid. [**get-form-definition-by-key**](#get-form-definition-by-key) | **Get** `/form-definitions/{formDefinitionID}` | Return a form definition. [**get-form-instance-by-key**](#get-form-instance-by-key) | **Get** `/form-instances/{formInstanceID}` | Returns a form instance. -[**get-form-instance-file**](#get-form-instance-file) | **Get** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId. +[**get-form-instance-file**](#get-form-instance-file) | **Get** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileid. [**import-form-definitions**](#import-form-definitions) | **Post** `/form-definitions/import` | Import form definitions from export. [**patch-form-definition**](#patch-form-definition) | **Patch** `/form-definitions/{formDefinitionID}` | Patch a form definition. [**patch-form-instance**](#patch-form-instance) | **Patch** `/form-instances/{formInstanceID}` | Patch a form instance. @@ -389,7 +389,7 @@ func main() { [[Back to top]](#) ## create-form-definition-dynamic-schema -Generate JSON Schema dynamically. +Generate json schema dynamically. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition-dynamic-schema) @@ -743,7 +743,7 @@ func main() { [[Back to top]](#) ## get-file-from-s3 -Download definition file by fileId. +Download definition file by fileid. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-file-from-s3) @@ -944,7 +944,7 @@ func main() { [[Back to top]](#) ## get-form-instance-file -Download instance file by fileId. +Download instance file by fileid. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-form-instance-file) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/CustomPasswordInstructionsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/CustomPasswordInstructionsAPI.md index 5a9d45a2f..4d7f02bc3 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/CustomPasswordInstructionsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/CustomPasswordInstructionsAPI.md @@ -26,13 +26,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-custom-password-instructions**](#create-custom-password-instructions) | **Post** `/custom-password-instructions` | Create Custom Password Instructions -[**delete-custom-password-instructions**](#delete-custom-password-instructions) | **Delete** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID -[**get-custom-password-instructions**](#get-custom-password-instructions) | **Get** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID +[**create-custom-password-instructions**](#create-custom-password-instructions) | **Post** `/custom-password-instructions` | Create custom password instructions +[**delete-custom-password-instructions**](#delete-custom-password-instructions) | **Delete** `/custom-password-instructions/{pageId}` | Delete custom password instructions by page id +[**get-custom-password-instructions**](#get-custom-password-instructions) | **Get** `/custom-password-instructions/{pageId}` | Get custom password instructions by page id ## create-custom-password-instructions -Create Custom Password Instructions +Create custom password instructions This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-custom-password-instructions) @@ -103,7 +103,7 @@ func main() { [[Back to top]](#) ## delete-custom-password-instructions -Delete Custom Password Instructions by page ID +Delete custom password instructions by page id This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-custom-password-instructions) @@ -170,7 +170,7 @@ func main() { [[Back to top]](#) ## get-custom-password-instructions -Get Custom Password Instructions by Page ID +Get custom password instructions by page id This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-custom-password-instructions) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/EntitlementsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/EntitlementsAPI.md index ee144b8a9..b8faa1a17 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/EntitlementsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/EntitlementsAPI.md @@ -67,14 +67,14 @@ Method | HTTP request | Description [**create-access-model-metadata-for-entitlement**](#create-access-model-metadata-for-entitlement) | **Post** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. [**delete-access-model-metadata-from-entitlement**](#delete-access-model-metadata-from-entitlement) | **Delete** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. [**get-entitlement**](#get-entitlement) | **Get** `/entitlements/{id}` | Get an entitlement -[**get-entitlement-request-config**](#get-entitlement-request-config) | **Get** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config -[**import-entitlements-by-source**](#import-entitlements-by-source) | **Post** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements +[**get-entitlement-request-config**](#get-entitlement-request-config) | **Get** `/entitlements/{id}/entitlement-request-config` | Get entitlement request config +[**import-entitlements-by-source**](#import-entitlements-by-source) | **Post** `/entitlements/aggregate/sources/{id}` | Aggregate entitlements [**list-entitlement-children**](#list-entitlement-children) | **Get** `/entitlements/{id}/children` | List of entitlements children [**list-entitlement-parents**](#list-entitlement-parents) | **Get** `/entitlements/{id}/parents` | List of entitlements parents [**list-entitlements**](#list-entitlements) | **Get** `/entitlements` | Gets a list of entitlements. [**patch-entitlement**](#patch-entitlement) | **Patch** `/entitlements/{id}` | Patch an entitlement -[**put-entitlement-request-config**](#put-entitlement-request-config) | **Put** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config -[**reset-source-entitlements**](#reset-source-entitlements) | **Post** `/entitlements/reset/sources/{sourceId}` | Reset Source Entitlements +[**put-entitlement-request-config**](#put-entitlement-request-config) | **Put** `/entitlements/{id}/entitlement-request-config` | Replace entitlement request config +[**reset-source-entitlements**](#reset-source-entitlements) | **Post** `/entitlements/reset/sources/{sourceId}` | Reset source entitlements [**update-entitlements-in-bulk**](#update-entitlements-in-bulk) | **Post** `/entitlements/bulk-update` | Bulk update an entitlement list @@ -288,7 +288,7 @@ func main() { [[Back to top]](#) ## get-entitlement-request-config -Get Entitlement Request Config +Get entitlement request config This API returns the entitlement request config for a specified entitlement. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-request-config) @@ -357,7 +357,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Aggregate Entitlements +Aggregate entitlements Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. @@ -737,7 +737,7 @@ func main() { [[Back to top]](#) ## put-entitlement-request-config -Replace Entitlement Request Config +Replace entitlement request config This API replaces the entitlement request config for a specified entitlement. [API Spec](https://developer.sailpoint.com/docs/api/beta/put-entitlement-request-config) @@ -832,7 +832,7 @@ func main() { [[Back to top]](#) ## reset-source-entitlements -Reset Source Entitlements +Reset source entitlements Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/GovernanceGroupsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/GovernanceGroupsAPI.md index 10b7130d7..b1a516211 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/GovernanceGroupsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/GovernanceGroupsAPI.md @@ -20,20 +20,20 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-workgroup**](#create-workgroup) | **Post** `/workgroups` | Create a new Governance Group. -[**delete-workgroup**](#delete-workgroup) | **Delete** `/workgroups/{id}` | Delete a Governance Group -[**delete-workgroup-members**](#delete-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group -[**delete-workgroups-in-bulk**](#delete-workgroups-in-bulk) | **Post** `/workgroups/bulk-delete` | Delete Governance Group(s) -[**get-workgroup**](#get-workgroup) | **Get** `/workgroups/{id}` | Get Governance Group by Id -[**list-connections**](#list-connections) | **Get** `/workgroups/{workgroupId}/connections` | List connections for Governance Group -[**list-workgroup-members**](#list-workgroup-members) | **Get** `/workgroups/{workgroupId}/members` | List Governance Group Members -[**list-workgroups**](#list-workgroups) | **Get** `/workgroups` | List Governance Groups -[**patch-workgroup**](#patch-workgroup) | **Patch** `/workgroups/{id}` | Patch a Governance Group -[**update-workgroup-members**](#update-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group +[**create-workgroup**](#create-workgroup) | **Post** `/workgroups` | Create a new governance group. +[**delete-workgroup**](#delete-workgroup) | **Delete** `/workgroups/{id}` | Delete a governance group +[**delete-workgroup-members**](#delete-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from governance group +[**delete-workgroups-in-bulk**](#delete-workgroups-in-bulk) | **Post** `/workgroups/bulk-delete` | Delete governance group(s) +[**get-workgroup**](#get-workgroup) | **Get** `/workgroups/{id}` | Get governance group by id +[**list-connections**](#list-connections) | **Get** `/workgroups/{workgroupId}/connections` | List connections for governance group +[**list-workgroup-members**](#list-workgroup-members) | **Get** `/workgroups/{workgroupId}/members` | List governance group members +[**list-workgroups**](#list-workgroups) | **Get** `/workgroups` | List governance groups +[**patch-workgroup**](#patch-workgroup) | **Patch** `/workgroups/{id}` | Patch a governance group +[**update-workgroup-members**](#update-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-add` | Add members to governance group ## create-workgroup -Create a new Governance Group. +Create a new governance group. This API creates a new Governance Group. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-workgroup) @@ -115,7 +115,7 @@ func main() { [[Back to top]](#) ## delete-workgroup -Delete a Governance Group +Delete a governance group This API deletes a Governance Group by its ID. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workgroup) @@ -180,7 +180,7 @@ func main() { [[Back to top]](#) ## delete-workgroup-members -Remove members from Governance Group +Remove members from governance group This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** @@ -257,7 +257,7 @@ func main() { [[Back to top]](#) ## delete-workgroups-in-bulk -Delete Governance Group(s) +Delete governance group(s) This API initiates a bulk deletion of one or more Governance Groups. @@ -337,7 +337,7 @@ func main() { [[Back to top]](#) ## get-workgroup -Get Governance Group by Id +Get governance group by id This API returns a Governance Groups by its ID. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-workgroup) @@ -403,7 +403,7 @@ func main() { [[Back to top]](#) ## list-connections -List connections for Governance Group +List connections for governance group This API returns list of connections associated with a Governance Group. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-connections) @@ -477,7 +477,7 @@ func main() { [[Back to top]](#) ## list-workgroup-members -List Governance Group Members +List governance group members This API returns list of members associated with a Governance Group. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-workgroup-members) @@ -551,7 +551,7 @@ func main() { [[Back to top]](#) ## list-workgroups -List Governance Groups +List governance groups This API returns list of Governance Groups [API Spec](https://developer.sailpoint.com/docs/api/beta/list-workgroups) @@ -621,7 +621,7 @@ func main() { [[Back to top]](#) ## patch-workgroup -Patch a Governance Group +Patch a governance group This API updates an existing governance group by ID. The following fields and objects are patchable: * name @@ -695,7 +695,7 @@ func main() { [[Back to top]](#) ## update-workgroup-members -Add members to Governance Group +Add members to governance group This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IAIAccessRequestRecommendationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IAIAccessRequestRecommendationsAPI.md index 09922f24c..b2c178c8d 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/IAIAccessRequestRecommendationsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IAIAccessRequestRecommendationsAPI.md @@ -15,18 +15,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **Post** `/ai-access-request-recommendations/ignored-items` | Ignore Access Request Recommendation -[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **Post** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation -[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **Post** `/ai-access-request-recommendations/viewed-items` | Mark Viewed Access Request Recommendations -[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **Post** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk Mark Viewed Access Request Recommendations -[**get-access-request-recommendations**](#get-access-request-recommendations) | **Get** `/ai-access-request-recommendations` | Identity Access Request Recommendations -[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **Get** `/ai-access-request-recommendations/ignored-items` | List Ignored Access Request Recommendations -[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **Get** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations -[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **Get** `/ai-access-request-recommendations/viewed-items` | List Viewed Access Request Recommendations +[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **Post** `/ai-access-request-recommendations/ignored-items` | Ignore access request recommendation +[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **Post** `/ai-access-request-recommendations/requested-items` | Accept access request recommendation +[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **Post** `/ai-access-request-recommendations/viewed-items` | Mark viewed access request recommendations +[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **Post** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk mark viewed access request recommendations +[**get-access-request-recommendations**](#get-access-request-recommendations) | **Get** `/ai-access-request-recommendations` | Identity access request recommendations +[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **Get** `/ai-access-request-recommendations/ignored-items` | List ignored access request recommendations +[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **Get** `/ai-access-request-recommendations/requested-items` | List accepted access request recommendations +[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **Get** `/ai-access-request-recommendations/viewed-items` | List viewed access request recommendations ## add-access-request-recommendations-ignored-item -Ignore Access Request Recommendation +Ignore access request recommendation This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. [API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-ignored-item) @@ -99,7 +99,7 @@ func main() { [[Back to top]](#) ## add-access-request-recommendations-requested-item -Accept Access Request Recommendation +Accept access request recommendation This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. [API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-requested-item) @@ -172,7 +172,7 @@ func main() { [[Back to top]](#) ## add-access-request-recommendations-viewed-item -Mark Viewed Access Request Recommendations +Mark viewed access request recommendations This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. [API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-viewed-item) @@ -245,7 +245,7 @@ func main() { [[Back to top]](#) ## add-access-request-recommendations-viewed-items -Bulk Mark Viewed Access Request Recommendations +Bulk mark viewed access request recommendations This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. [API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-viewed-items) @@ -312,7 +312,7 @@ func main() { [[Back to top]](#) ## get-access-request-recommendations -Identity Access Request Recommendations +Identity access request recommendations This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations) @@ -386,7 +386,7 @@ func main() { [[Back to top]](#) ## get-access-request-recommendations-ignored-items -List Ignored Access Request Recommendations +List ignored access request recommendations This API returns the list of ignored access request recommendations. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-ignored-items) @@ -456,7 +456,7 @@ func main() { [[Back to top]](#) ## get-access-request-recommendations-requested-items -List Accepted Access Request Recommendations +List accepted access request recommendations This API returns a list of requested access request recommendations. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-requested-items) @@ -526,7 +526,7 @@ func main() { [[Back to top]](#) ## get-access-request-recommendations-viewed-items -List Viewed Access Request Recommendations +List viewed access request recommendations This API returns the list of viewed access request recommendations. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-viewed-items) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IAIMessageCatalogsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IAIMessageCatalogsAPI.md index e2a57661f..282cb4196 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/IAIMessageCatalogsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IAIMessageCatalogsAPI.md @@ -15,11 +15,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-message-catalogs**](#get-message-catalogs) | **Get** `/translation-catalogs/{catalog-id}` | Get Message catalogs +[**get-message-catalogs**](#get-message-catalogs) | **Get** `/translation-catalogs/{catalog-id}` | Get message catalogs ## get-message-catalogs -Get Message catalogs +Get message catalogs The getMessageCatalogs API returns message catalog based on the language headers in the requested object. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-message-catalogs) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IAIOutliersAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IAIOutliersAPI.md index 696fd7279..7bb7f9dba 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/IAIOutliersAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IAIOutliersAPI.md @@ -15,19 +15,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**export-outliers-zip**](#export-outliers-zip) | **Get** `/outliers/export` | IAI Identity Outliers Export -[**get-identity-outlier-snapshots**](#get-identity-outlier-snapshots) | **Get** `/outlier-summaries` | IAI Identity Outliers Summary -[**get-identity-outliers**](#get-identity-outliers) | **Get** `/outliers` | IAI Get Identity Outliers -[**get-latest-identity-outlier-snapshots**](#get-latest-identity-outlier-snapshots) | **Get** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary +[**export-outliers-zip**](#export-outliers-zip) | **Get** `/outliers/export` | Iai identity outliers export +[**get-identity-outlier-snapshots**](#get-identity-outlier-snapshots) | **Get** `/outlier-summaries` | Iai identity outliers summary +[**get-identity-outliers**](#get-identity-outliers) | **Get** `/outliers` | Iai get identity outliers +[**get-latest-identity-outlier-snapshots**](#get-latest-identity-outlier-snapshots) | **Get** `/outlier-summaries/latest` | Iai identity outliers latest summary [**get-outlier-contributing-feature-summary**](#get-outlier-contributing-feature-summary) | **Get** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary [**get-peer-group-outliers-contributing-features**](#get-peer-group-outliers-contributing-features) | **Get** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features -[**ignore-identity-outliers**](#ignore-identity-outliers) | **Post** `/outliers/ignore` | IAI Identity Outliers Ignore +[**ignore-identity-outliers**](#ignore-identity-outliers) | **Post** `/outliers/ignore` | Iai identity outliers ignore [**list-outliers-contributing-feature-access-items**](#list-outliers-contributing-feature-access-items) | **Get** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature -[**un-ignore-identity-outliers**](#un-ignore-identity-outliers) | **Post** `/outliers/unignore` | IAI Identity Outliers Unignore +[**un-ignore-identity-outliers**](#un-ignore-identity-outliers) | **Post** `/outliers/unignore` | Iai identity outliers unignore ## export-outliers-zip -IAI Identity Outliers Export +Iai identity outliers export This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). @@ -92,7 +92,7 @@ func main() { [[Back to top]](#) ## get-identity-outlier-snapshots -IAI Identity Outliers Summary +Iai identity outliers summary This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-outlier-snapshots) @@ -162,7 +162,7 @@ func main() { [[Back to top]](#) ## get-identity-outliers -IAI Get Identity Outliers +Iai get identity outliers This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-outliers) @@ -234,7 +234,7 @@ func main() { [[Back to top]](#) ## get-latest-identity-outlier-snapshots -IAI Identity Outliers Latest Summary +Iai identity outliers latest summary This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-latest-identity-outlier-snapshots) @@ -444,7 +444,7 @@ func main() { [[Back to top]](#) ## ignore-identity-outliers -IAI Identity Outliers Ignore +Iai identity outliers ignore This API receives a list of identity IDs in the request, changes the outliers to be ignored. [API Spec](https://developer.sailpoint.com/docs/api/beta/ignore-identity-outliers) @@ -592,7 +592,7 @@ func main() { [[Back to top]](#) ## un-ignore-identity-outliers -IAI Identity Outliers Unignore +Iai identity outliers unignore This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. [API Spec](https://developer.sailpoint.com/docs/api/beta/un-ignore-identity-outliers) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IAIPeerGroupStrategiesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IAIPeerGroupStrategiesAPI.md index a8f90e6cf..341b98fd7 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/IAIPeerGroupStrategiesAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IAIPeerGroupStrategiesAPI.md @@ -15,14 +15,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-peer-group-outliers**](#get-peer-group-outliers) | **Get** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List +[**get-peer-group-outliers**](#get-peer-group-outliers) | **Get** `/peer-group-strategies/{strategy}/identity-outliers` | Identity outliers list ## get-peer-group-outliers :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Identity Outliers List +Identity outliers list -- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-peer-group-outliers) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IAIRecommendationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IAIRecommendationsAPI.md index f6612f41a..77acd36bb 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/IAIRecommendationsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IAIRecommendationsAPI.md @@ -15,13 +15,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-recommendations**](#get-recommendations) | **Post** `/recommendations/request` | Returns Recommendation Based on Object +[**get-recommendations**](#get-recommendations) | **Post** `/recommendations/request` | Returns recommendation based on object [**get-recommendations-config**](#get-recommendations-config) | **Get** `/recommendations/config` | Get certification recommendation config values [**update-recommendations-config**](#update-recommendations-config) | **Put** `/recommendations/config` | Update certification recommendation config values ## get-recommendations -Returns Recommendation Based on Object +Returns recommendation based on object The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-recommendations) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IAIRoleMiningAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IAIRoleMiningAPI.md index 0f428dbc3..02334b00e 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/IAIRoleMiningAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IAIRoleMiningAPI.md @@ -19,7 +19,7 @@ Method | HTTP request | Description [**create-role-mining-sessions**](#create-role-mining-sessions) | **Post** `/role-mining-sessions` | Create a role mining session [**download-role-mining-potential-role-zip**](#download-role-mining-potential-role-zip) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` | Export (download) details for a potential role in a role mining session [**export-role-mining-potential-role**](#export-role-mining-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` | Export (download) details for a potential role in a role mining session -[**export-role-mining-potential-role-async**](#export-role-mining-potential-role-async) | **Post** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to S3 +[**export-role-mining-potential-role-async**](#export-role-mining-potential-role-async) | **Post** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to s3 [**export-role-mining-potential-role-status**](#export-role-mining-potential-role-status) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` | Retrieve status of a potential role export job [**get-all-potential-role-summaries**](#get-all-potential-role-summaries) | **Get** `/role-mining-potential-roles` | Retrieves all potential role summaries [**get-entitlement-distribution-potential-role**](#get-entitlement-distribution-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` | Retrieves entitlement popularity distribution for a potential role in a role mining session @@ -363,7 +363,7 @@ func main() { [[Back to top]](#) ## export-role-mining-potential-role-async -Asynchronously export details for a potential role in a role mining session and upload to S3 +Asynchronously export details for a potential role in a role mining session and upload to s3 This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. [API Spec](https://developer.sailpoint.com/docs/api/beta/export-role-mining-potential-role-async) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IdentitiesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IdentitiesAPI.md index 17e78fe49..a964113a9 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/IdentitiesAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IdentitiesAPI.md @@ -31,15 +31,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- [**delete-identity**](#delete-identity) | **Delete** `/identities/{id}` | Delete identity -[**get-identity**](#get-identity) | **Get** `/identities/{id}` | Identity Details +[**get-identity**](#get-identity) | **Get** `/identities/{id}` | Identity details [**get-identity-ownership-details**](#get-identity-ownership-details) | **Get** `/identities/{identityId}/ownership` | Get ownership details [**get-role-assignment**](#get-role-assignment) | **Get** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details [**get-role-assignments**](#get-role-assignments) | **Get** `/identities/{identityId}/role-assignments` | List role assignments -[**list-identities**](#list-identities) | **Get** `/identities` | List Identities +[**list-identities**](#list-identities) | **Get** `/identities` | List identities [**reset-identity**](#reset-identity) | **Post** `/identities/{identityId}/reset` | Reset an identity [**send-identity-verification-account-token**](#send-identity-verification-account-token) | **Post** `/identities/{id}/verification/account/send` | Send password reset email [**start-identities-invite**](#start-identities-invite) | **Post** `/identities/invite` | Invite identities to register -[**start-identity-processing**](#start-identity-processing) | **Post** `/identities/process` | Process a list of identityIds +[**start-identity-processing**](#start-identity-processing) | **Post** `/identities/process` | Process a list of identityids [**synchronize-attributes-for-identity**](#synchronize-attributes-for-identity) | **Post** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. @@ -109,7 +109,7 @@ func main() { [[Back to top]](#) ## get-identity -Identity Details +Identity details This API returns a single identity using the Identity ID. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity) @@ -382,7 +382,7 @@ func main() { [[Back to top]](#) ## list-identities -List Identities +List identities This API returns a list of identities. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-identities) @@ -670,7 +670,7 @@ func main() { [[Back to top]](#) ## start-identity-processing -Process a list of identityIds +Process a list of identityids This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. This endpoint will perform the following tasks: diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IdentityAttributesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IdentityAttributesAPI.md index a3d612f48..eb299ea5d 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/IdentityAttributesAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IdentityAttributesAPI.md @@ -15,16 +15,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-identity-attribute**](#create-identity-attribute) | **Post** `/identity-attributes` | Create Identity Attribute -[**delete-identity-attribute**](#delete-identity-attribute) | **Delete** `/identity-attributes/{name}` | Delete Identity Attribute -[**delete-identity-attributes-in-bulk**](#delete-identity-attributes-in-bulk) | **Delete** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes -[**get-identity-attribute**](#get-identity-attribute) | **Get** `/identity-attributes/{name}` | Get Identity Attribute -[**list-identity-attributes**](#list-identity-attributes) | **Get** `/identity-attributes` | List Identity Attributes -[**put-identity-attribute**](#put-identity-attribute) | **Put** `/identity-attributes/{name}` | Update Identity Attribute +[**create-identity-attribute**](#create-identity-attribute) | **Post** `/identity-attributes` | Create identity attribute +[**delete-identity-attribute**](#delete-identity-attribute) | **Delete** `/identity-attributes/{name}` | Delete identity attribute +[**delete-identity-attributes-in-bulk**](#delete-identity-attributes-in-bulk) | **Delete** `/identity-attributes/bulk-delete` | Bulk delete identity attributes +[**get-identity-attribute**](#get-identity-attribute) | **Get** `/identity-attributes/{name}` | Get identity attribute +[**list-identity-attributes**](#list-identity-attributes) | **Get** `/identity-attributes` | List identity attributes +[**put-identity-attribute**](#put-identity-attribute) | **Put** `/identity-attributes/{name}` | Update identity attribute ## create-identity-attribute -Create Identity Attribute +Create identity attribute Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-attribute) @@ -112,7 +112,7 @@ func main() { [[Back to top]](#) ## delete-identity-attribute -Delete Identity Attribute +Delete identity attribute This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attribute) @@ -177,7 +177,7 @@ func main() { [[Back to top]](#) ## delete-identity-attributes-in-bulk -Bulk delete Identity Attributes +Bulk delete identity attributes Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attributes-in-bulk) @@ -245,7 +245,7 @@ func main() { [[Back to top]](#) ## get-identity-attribute -Get Identity Attribute +Get identity attribute This gets an identity attribute for a given technical name. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-attribute) @@ -311,7 +311,7 @@ func main() { [[Back to top]](#) ## list-identity-attributes -List Identity Attributes +List identity attributes Use this API to get a collection of identity attributes. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-attributes) @@ -379,7 +379,7 @@ func main() { [[Back to top]](#) ## put-identity-attribute -Update Identity Attribute +Update identity attribute This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/put-identity-attribute) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IdentityHistoryAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IdentityHistoryAPI.md index a62d03a91..f7a0757c9 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/IdentityHistoryAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IdentityHistoryAPI.md @@ -16,15 +16,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- [**compare-identity-snapshots**](#compare-identity-snapshots) | **Get** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots -[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **Get** `/historical-identities/{id}/compare/{accessType}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots +[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **Get** `/historical-identities/{id}/compare/{accessType}` | Gets a list of differences of specific accesstype for the given identity between 2 snapshots [**get-historical-identity**](#get-historical-identity) | **Get** `/historical-identities/{id}` | Get latest snapshot of identity [**get-historical-identity-events**](#get-historical-identity-events) | **Get** `/historical-identities/{id}/events` | Lists all events for the given identity [**get-identity-snapshot**](#get-identity-snapshot) | **Get** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date [**get-identity-snapshot-summary**](#get-identity-snapshot-summary) | **Get** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity [**get-identity-start-date**](#get-identity-start-date) | **Get** `/historical-identities/{id}/start-date` | Gets the start date of the identity [**list-historical-identities**](#list-historical-identities) | **Get** `/historical-identities` | Lists all the identities -[**list-identity-access-items**](#list-identity-access-items) | **Get** `/historical-identities/{id}/access-items` | List Access Items by Identity -[**list-identity-snapshot-access-items**](#list-identity-snapshot-access-items) | **Get** `/historical-identities/{id}/snapshots/{date}/access-items` | Get Identity Access Items Snapshot +[**list-identity-access-items**](#list-identity-access-items) | **Get** `/historical-identities/{id}/access-items` | List access items by identity +[**list-identity-snapshot-access-items**](#list-identity-snapshot-access-items) | **Get** `/historical-identities/{id}/snapshots/{date}/access-items` | Get identity access items snapshot [**list-identity-snapshots**](#list-identity-snapshots) | **Get** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity @@ -107,7 +107,7 @@ func main() { [[Back to top]](#) ## compare-identity-snapshots-access-type -Gets a list of differences of specific accessType for the given identity between 2 snapshots +Gets a list of differences of specific accesstype for the given identity between 2 snapshots This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' [API Spec](https://developer.sailpoint.com/docs/api/beta/compare-identity-snapshots-access-type) @@ -615,7 +615,7 @@ func main() { [[Back to top]](#) ## list-identity-access-items -List Access Items by Identity +List access items by identity This method retrieves a list of access item for the identity filtered by the access item type [API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-access-items) @@ -695,7 +695,7 @@ func main() { [[Back to top]](#) ## list-identity-snapshot-access-items -Get Identity Access Items Snapshot +Get identity access items snapshot Use this API to get a list of identity access items at a specified date, filtered by item type. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-snapshot-access-items) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IdentityProfilesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IdentityProfilesAPI.md index b1f993b45..75ac0eb6e 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/IdentityProfilesAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IdentityProfilesAPI.md @@ -26,21 +26,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-identity-profile**](#create-identity-profile) | **Post** `/identity-profiles` | Create Identity Profile -[**delete-identity-profile**](#delete-identity-profile) | **Delete** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile -[**delete-identity-profiles**](#delete-identity-profiles) | **Post** `/identity-profiles/bulk-delete` | Delete Identity Profiles -[**export-identity-profiles**](#export-identity-profiles) | **Get** `/identity-profiles/export` | Export Identity Profiles +[**create-identity-profile**](#create-identity-profile) | **Post** `/identity-profiles` | Create identity profile +[**delete-identity-profile**](#delete-identity-profile) | **Delete** `/identity-profiles/{identity-profile-id}` | Delete identity profile +[**delete-identity-profiles**](#delete-identity-profiles) | **Post** `/identity-profiles/bulk-delete` | Delete identity profiles +[**export-identity-profiles**](#export-identity-profiles) | **Get** `/identity-profiles/export` | Export identity profiles [**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **Get** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Default identity attribute config -[**get-identity-profile**](#get-identity-profile) | **Get** `/identity-profiles/{identity-profile-id}` | Get Identity Profile -[**import-identity-profiles**](#import-identity-profiles) | **Post** `/identity-profiles/import` | Import Identity Profiles -[**list-identity-profiles**](#list-identity-profiles) | **Get** `/identity-profiles` | List Identity Profiles -[**show-generate-identity-preview**](#show-generate-identity-preview) | **Post** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**get-identity-profile**](#get-identity-profile) | **Get** `/identity-profiles/{identity-profile-id}` | Get identity profile +[**import-identity-profiles**](#import-identity-profiles) | **Post** `/identity-profiles/import` | Import identity profiles +[**list-identity-profiles**](#list-identity-profiles) | **Get** `/identity-profiles` | List identity profiles +[**show-generate-identity-preview**](#show-generate-identity-preview) | **Post** `/identity-profiles/identity-preview` | Generate identity profile preview [**sync-identity-profile**](#sync-identity-profile) | **Post** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile -[**update-identity-profile**](#update-identity-profile) | **Patch** `/identity-profiles/{identity-profile-id}` | Update Identity Profile +[**update-identity-profile**](#update-identity-profile) | **Patch** `/identity-profiles/{identity-profile-id}` | Update identity profile ## create-identity-profile -Create Identity Profile +Create identity profile Create an identity profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile. @@ -156,7 +156,7 @@ func main() { [[Back to top]](#) ## delete-identity-profile -Delete Identity Profile +Delete identity profile Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. @@ -224,7 +224,7 @@ func main() { [[Back to top]](#) ## delete-identity-profiles -Delete Identity Profiles +Delete identity profiles This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. @@ -297,7 +297,7 @@ func main() { [[Back to top]](#) ## export-identity-profiles -Export Identity Profiles +Export identity profiles This exports existing identity profiles in the format specified by the sp-config service. [API Spec](https://developer.sailpoint.com/docs/api/beta/export-identity-profiles) @@ -434,7 +434,7 @@ func main() { [[Back to top]](#) ## get-identity-profile -Get Identity Profile +Get identity profile Get a single identity profile by ID. A token with ORG_ADMIN or API authority is required to call this API. @@ -501,7 +501,7 @@ func main() { [[Back to top]](#) ## import-identity-profiles -Import Identity Profiles +Import identity profiles This imports previously exported identity profiles. [API Spec](https://developer.sailpoint.com/docs/api/beta/import-identity-profiles) @@ -568,7 +568,7 @@ func main() { [[Back to top]](#) ## list-identity-profiles -List Identity Profiles +List identity profiles Get a list of identity profiles, based on the specified query parameters. A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. @@ -639,7 +639,7 @@ func main() { [[Back to top]](#) ## show-generate-identity-preview -Generate Identity Profile Preview +Generate identity profile preview Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. A token with ORG_ADMIN authority is required to call this API to generate an identity preview. @@ -805,7 +805,7 @@ func main() { [[Back to top]](#) ## update-identity-profile -Update Identity Profile +Update identity profile Update the specified identity profile with this PATCH request. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. These fields cannot be updated: diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/LaunchersAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/LaunchersAPI.md index 3d6588a28..3f3d56045 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/LaunchersAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/LaunchersAPI.md @@ -19,11 +19,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-launcher**](#create-launcher) | **Post** `/launchers` | Create launcher -[**delete-launcher**](#delete-launcher) | **Delete** `/launchers/{launcherID}` | Delete Launcher -[**get-launcher**](#get-launcher) | **Get** `/launchers/{launcherID}` | Get Launcher by ID -[**get-launchers**](#get-launchers) | **Get** `/launchers` | List all Launchers for tenant -[**put-launcher**](#put-launcher) | **Put** `/launchers/{launcherID}` | Replace Launcher -[**start-launcher**](#start-launcher) | **Post** `/beta/launchers/{launcherID}/launch` | Launch a Launcher +[**delete-launcher**](#delete-launcher) | **Delete** `/launchers/{launcherID}` | Delete launcher +[**get-launcher**](#get-launcher) | **Get** `/launchers/{launcherID}` | Get launcher by id +[**get-launchers**](#get-launchers) | **Get** `/launchers` | List all launchers for tenant +[**put-launcher**](#put-launcher) | **Put** `/launchers/{launcherID}` | Replace launcher +[**start-launcher**](#start-launcher) | **Post** `/beta/launchers/{launcherID}/launch` | Launch a launcher ## create-launcher @@ -104,7 +104,7 @@ func main() { [[Back to top]](#) ## delete-launcher -Delete Launcher +Delete launcher Delete the given Launcher ID [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-launcher) @@ -169,7 +169,7 @@ func main() { [[Back to top]](#) ## get-launcher -Get Launcher by ID +Get launcher by id Get details for the given Launcher ID [API Spec](https://developer.sailpoint.com/docs/api/beta/get-launcher) @@ -235,7 +235,7 @@ func main() { [[Back to top]](#) ## get-launchers -List all Launchers for tenant +List all launchers for tenant Return a list of Launchers for the authenticated tenant [API Spec](https://developer.sailpoint.com/docs/api/beta/get-launchers) @@ -301,7 +301,7 @@ func main() { [[Back to top]](#) ## put-launcher -Replace Launcher +Replace launcher Replace the given Launcher ID with given payload [API Spec](https://developer.sailpoint.com/docs/api/beta/put-launcher) @@ -384,7 +384,7 @@ func main() { [[Back to top]](#) ## start-launcher -Launch a Launcher +Launch a launcher Launch the given Launcher ID [API Spec](https://developer.sailpoint.com/docs/api/beta/start-launcher) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/LifecycleStatesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/LifecycleStatesAPI.md index cf01c6d10..0a62d64c4 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/LifecycleStatesAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/LifecycleStatesAPI.md @@ -51,12 +51,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-lifecycle-states**](#get-lifecycle-states) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State -[**update-lifecycle-states**](#update-lifecycle-states) | **Patch** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State +[**get-lifecycle-states**](#get-lifecycle-states) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get lifecycle state +[**update-lifecycle-states**](#update-lifecycle-states) | **Patch** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update lifecycle state ## get-lifecycle-states -Get Lifecycle State +Get lifecycle state Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. A token with ORG_ADMIN or API authority is required to call this API. @@ -128,7 +128,7 @@ func main() { [[Back to top]](#) ## update-lifecycle-states -Update Lifecycle State +Update lifecycle state Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or API authority is required to call this API. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/MFAConfigurationAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/MFAConfigurationAPI.md index ab983f302..4bc5d868b 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/MFAConfigurationAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/MFAConfigurationAPI.md @@ -15,18 +15,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**delete-mfa-config**](#delete-mfa-config) | **Delete** `/mfa/{method}/delete` | Delete MFA method configuration -[**get-mfa-duo-config**](#get-mfa-duo-config) | **Get** `/mfa/duo-web/config` | Configuration of Duo MFA method -[**get-mfa-kba-config**](#get-mfa-kba-config) | **Get** `/mfa/kba/config` | Configuration of KBA MFA method -[**get-mfa-okta-config**](#get-mfa-okta-config) | **Get** `/mfa/okta-verify/config` | Configuration of Okta MFA method -[**set-mfa-duo-config**](#set-mfa-duo-config) | **Put** `/mfa/duo-web/config` | Set Duo MFA configuration -[**set-mfakba-config**](#set-mfakba-config) | **Post** `/mfa/kba/config/answers` | Set MFA KBA configuration -[**set-mfa-okta-config**](#set-mfa-okta-config) | **Put** `/mfa/okta-verify/config` | Set Okta MFA configuration -[**test-mfa-config**](#test-mfa-config) | **Get** `/mfa/{method}/test` | MFA method's test configuration +[**delete-mfa-config**](#delete-mfa-config) | **Delete** `/mfa/{method}/delete` | Delete mfa method configuration +[**get-mfa-duo-config**](#get-mfa-duo-config) | **Get** `/mfa/duo-web/config` | Configuration of duo mfa method +[**get-mfa-kba-config**](#get-mfa-kba-config) | **Get** `/mfa/kba/config` | Configuration of kba mfa method +[**get-mfa-okta-config**](#get-mfa-okta-config) | **Get** `/mfa/okta-verify/config` | Configuration of okta mfa method +[**set-mfa-duo-config**](#set-mfa-duo-config) | **Put** `/mfa/duo-web/config` | Set duo mfa configuration +[**set-mfakba-config**](#set-mfakba-config) | **Post** `/mfa/kba/config/answers` | Set mfa kba configuration +[**set-mfa-okta-config**](#set-mfa-okta-config) | **Put** `/mfa/okta-verify/config` | Set okta mfa configuration +[**test-mfa-config**](#test-mfa-config) | **Get** `/mfa/{method}/test` | Mfa method's test configuration ## delete-mfa-config -Delete MFA method configuration +Delete mfa method configuration This API removes the configuration for the specified MFA method. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-mfa-config) @@ -92,7 +92,7 @@ func main() { [[Back to top]](#) ## get-mfa-duo-config -Configuration of Duo MFA method +Configuration of duo mfa method This API returns the configuration of an Duo MFA method. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-duo-config) @@ -149,7 +149,7 @@ func main() { [[Back to top]](#) ## get-mfa-kba-config -Configuration of KBA MFA method +Configuration of kba mfa method This API returns the KBA configuration for MFA. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-kba-config) @@ -211,7 +211,7 @@ func main() { [[Back to top]](#) ## get-mfa-okta-config -Configuration of Okta MFA method +Configuration of okta mfa method This API returns the configuration of an Okta MFA method. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-okta-config) @@ -268,7 +268,7 @@ func main() { [[Back to top]](#) ## set-mfa-duo-config -Set Duo MFA configuration +Set duo mfa configuration This API sets the configuration of an Duo MFA method. [API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfa-duo-config) @@ -345,7 +345,7 @@ func main() { [[Back to top]](#) ## set-mfakba-config -Set MFA KBA configuration +Set mfa kba configuration This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. [API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfakba-config) @@ -412,7 +412,7 @@ func main() { [[Back to top]](#) ## set-mfa-okta-config -Set Okta MFA configuration +Set okta mfa configuration This API sets the configuration of an Okta MFA method. [API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfa-okta-config) @@ -485,7 +485,7 @@ func main() { [[Back to top]](#) ## test-mfa-config -MFA method's test configuration +Mfa method's test configuration This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. [API Spec](https://developer.sailpoint.com/docs/api/beta/test-mfa-config) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/MFAControllerAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/MFAControllerAPI.md index 30a03f05a..4d2d1ff98 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/MFAControllerAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/MFAControllerAPI.md @@ -16,11 +16,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-send-token**](#create-send-token) | **Post** `/mfa/token/send` | Create and send user token -[**ping-verification-status**](#ping-verification-status) | **Post** `/mfa/{method}/poll` | Polling MFA method by VerificationPollRequest -[**send-duo-verify-request**](#send-duo-verify-request) | **Post** `/mfa/duo-web/verify` | Verifying authentication via Duo method -[**send-kba-answers**](#send-kba-answers) | **Post** `/mfa/kba/authenticate` | Authenticate KBA provided MFA method -[**send-okta-verify-request**](#send-okta-verify-request) | **Post** `/mfa/okta-verify/verify` | Verifying authentication via Okta method -[**send-token-auth-request**](#send-token-auth-request) | **Post** `/mfa/token/authenticate` | Authenticate Token provided MFA method +[**ping-verification-status**](#ping-verification-status) | **Post** `/mfa/{method}/poll` | Polling mfa method by verificationpollrequest +[**send-duo-verify-request**](#send-duo-verify-request) | **Post** `/mfa/duo-web/verify` | Verifying authentication via duo method +[**send-kba-answers**](#send-kba-answers) | **Post** `/mfa/kba/authenticate` | Authenticate kba provided mfa method +[**send-okta-verify-request**](#send-okta-verify-request) | **Post** `/mfa/okta-verify/verify` | Verifying authentication via okta method +[**send-token-auth-request**](#send-token-auth-request) | **Post** `/mfa/token/authenticate` | Authenticate token provided mfa method ## create-send-token @@ -94,7 +94,7 @@ func main() { [[Back to top]](#) ## ping-verification-status -Polling MFA method by VerificationPollRequest +Polling mfa method by verificationpollrequest This API poll the VerificationPollRequest for the specified MFA method. [API Spec](https://developer.sailpoint.com/docs/api/beta/ping-verification-status) @@ -169,7 +169,7 @@ func main() { [[Back to top]](#) ## send-duo-verify-request -Verifying authentication via Duo method +Verifying authentication via duo method This API Authenticates the user via Duo-Web MFA method. [API Spec](https://developer.sailpoint.com/docs/api/beta/send-duo-verify-request) @@ -239,7 +239,7 @@ func main() { [[Back to top]](#) ## send-kba-answers -Authenticate KBA provided MFA method +Authenticate kba provided mfa method This API Authenticate user in KBA MFA method. [API Spec](https://developer.sailpoint.com/docs/api/beta/send-kba-answers) @@ -306,7 +306,7 @@ func main() { [[Back to top]](#) ## send-okta-verify-request -Verifying authentication via Okta method +Verifying authentication via okta method This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller. [API Spec](https://developer.sailpoint.com/docs/api/beta/send-okta-verify-request) @@ -375,7 +375,7 @@ func main() { [[Back to top]](#) ## send-token-auth-request -Authenticate Token provided MFA method +Authenticate token provided mfa method This API Authenticate user in Token MFA method. [API Spec](https://developer.sailpoint.com/docs/api/beta/send-token-auth-request) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClientsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClientsAPI.md index e1dba9457..4ef1c9203 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClientsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClientsAPI.md @@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-managed-client-status**](#get-managed-client-status) | **Get** `/managed-clients/{id}/status` | Specified Managed Client Status. +[**get-managed-client-status**](#get-managed-client-status) | **Get** `/managed-clients/{id}/status` | Specified managed client status. [**update-managed-client-status**](#update-managed-client-status) | **Post** `/managed-clients/{id}/status` | Handle status request from client @@ -25,7 +25,7 @@ Method | HTTP request | Description :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Specified Managed Client Status. +Specified managed client status. Retrieve Managed Client Status by ID. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-client-status) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClustersAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClustersAPI.md index 66944b4c7..148fac454 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClustersAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClustersAPI.md @@ -18,8 +18,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- [**get-client-log-configuration**](#get-client-log-configuration) | **Get** `/managed-clusters/{id}/log-config` | Get managed cluster's log configuration -[**get-managed-cluster**](#get-managed-cluster) | **Get** `/managed-clusters/{id}` | Get a specified ManagedCluster. -[**get-managed-clusters**](#get-managed-clusters) | **Get** `/managed-clusters` | Retrieve all Managed Clusters. +[**get-managed-cluster**](#get-managed-cluster) | **Get** `/managed-clusters/{id}` | Get a specified managedcluster. +[**get-managed-clusters**](#get-managed-clusters) | **Get** `/managed-clusters` | Retrieve all managed clusters. [**put-client-log-configuration**](#put-client-log-configuration) | **Put** `/managed-clusters/{id}/log-config` | Update managed cluster's log configuration @@ -96,7 +96,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Get a specified ManagedCluster. +Get a specified managedcluster. Retrieve a ManagedCluster by ID. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-cluster) @@ -165,7 +165,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Retrieve all Managed Clusters. +Retrieve all managed clusters. Retrieve all Managed Clusters for the current Org, based on request context. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-clusters) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/MultiHostIntegrationAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/MultiHostIntegrationAPI.md index c6bc3cbb6..92ff339fa 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/MultiHostIntegrationAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/MultiHostIntegrationAPI.md @@ -18,23 +18,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-multi-host-integration**](#create-multi-host-integration) | **Post** `/multihosts` | Create Multi-Host Integration -[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **Post** `/multihosts/{multihostId}` | Create Sources Within Multi-Host Integration -[**delete-multi-host**](#delete-multi-host) | **Delete** `/multihosts/{multihostId}` | Delete Multi-Host Integration -[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **Get** `/multihosts/{multihostId}/acctAggregationGroups` | Get Account Aggregation Groups Within Multi-Host Integration ID -[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **Get** `/multihosts/{multiHostId}/entitlementAggregationGroups` | Get Entitlement Aggregation Groups Within Multi-Host Integration ID -[**get-multi-host-integrations**](#get-multi-host-integrations) | **Get** `/multihosts/{multihostId}` | Get Multi-Host Integration By ID -[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **Get** `/multihosts` | List All Existing Multi-Host Integrations -[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **Get** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors -[**get-multihost-integration-types**](#get-multihost-integration-types) | **Get** `/multihosts/types` | List Multi-Host Integration Types -[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **Get** `/multihosts/{multihostId}/sources` | List Sources Within Multi-Host Integration -[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **Post** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration -[**test-source-connection-multihost**](#test-source-connection-multihost) | **Get** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source -[**update-multi-host-sources**](#update-multi-host-sources) | **Patch** `/multihosts/{multihostId}` | Update Multi-Host Integration +[**create-multi-host-integration**](#create-multi-host-integration) | **Post** `/multihosts` | Create multi-host integration +[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **Post** `/multihosts/{multihostId}` | Create sources within multi-host integration +[**delete-multi-host**](#delete-multi-host) | **Delete** `/multihosts/{multihostId}` | Delete multi-host integration +[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **Get** `/multihosts/{multihostId}/acctAggregationGroups` | Get account aggregation groups within multi-host integration id +[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **Get** `/multihosts/{multiHostId}/entitlementAggregationGroups` | Get entitlement aggregation groups within multi-host integration id +[**get-multi-host-integrations**](#get-multi-host-integrations) | **Get** `/multihosts/{multihostId}` | Get multi-host integration by id +[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **Get** `/multihosts` | List all existing multi-host integrations +[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **Get** `/multihosts/{multiHostId}/sources/errors` | List multi-host source creation errors +[**get-multihost-integration-types**](#get-multihost-integration-types) | **Get** `/multihosts/types` | List multi-host integration types +[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **Get** `/multihosts/{multihostId}/sources` | List sources within multi-host integration +[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **Post** `/multihosts/{multihostId}/sources/testConnection` | Test configuration for multi-host integration +[**test-source-connection-multihost**](#test-source-connection-multihost) | **Get** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test configuration for multi-host integration's single source +[**update-multi-host-sources**](#update-multi-host-sources) | **Patch** `/multihosts/{multihostId}` | Update multi-host integration ## create-multi-host-integration -Create Multi-Host Integration +Create multi-host integration This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -128,7 +128,7 @@ func main() { [[Back to top]](#) ## create-sources-within-multi-host -Create Sources Within Multi-Host Integration +Create sources within multi-host integration This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -202,7 +202,7 @@ func main() { [[Back to top]](#) ## delete-multi-host -Delete Multi-Host Integration +Delete multi-host integration Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. @@ -269,7 +269,7 @@ func main() { [[Back to top]](#) ## get-acct-aggregation-groups -Get Account Aggregation Groups Within Multi-Host Integration ID +Get account aggregation groups within multi-host integration id This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -337,7 +337,7 @@ func main() { [[Back to top]](#) ## get-entitlement-aggregation-groups -Get Entitlement Aggregation Groups Within Multi-Host Integration ID +Get entitlement aggregation groups within multi-host integration id This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -405,7 +405,7 @@ func main() { [[Back to top]](#) ## get-multi-host-integrations -Get Multi-Host Integration By ID +Get multi-host integration by id Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. @@ -473,7 +473,7 @@ func main() { [[Back to top]](#) ## get-multi-host-integrations-list -List All Existing Multi-Host Integrations +List all existing multi-host integrations Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -547,7 +547,7 @@ func main() { [[Back to top]](#) ## get-multi-host-source-creation-errors -List Multi-Host Source Creation Errors +List multi-host source creation errors Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -615,7 +615,7 @@ func main() { [[Back to top]](#) ## get-multihost-integration-types -List Multi-Host Integration Types +List multi-host integration types This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -674,7 +674,7 @@ func main() { [[Back to top]](#) ## get-sources-within-multi-host -List Sources Within Multi-Host Integration +List sources within multi-host integration Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -752,7 +752,7 @@ func main() { [[Back to top]](#) ## test-connection-multi-host-sources -Test Configuration For Multi-Host Integration +Test configuration for multi-host integration This endpoint performs a more detailed validation of the Multi-Host Integration's configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -819,7 +819,7 @@ func main() { [[Back to top]](#) ## test-source-connection-multihost -Test Configuration For Multi-Host Integration's Single Source +Test configuration for multi-host integration's single source This endpoint performs a more detailed validation of the source's configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -890,7 +890,7 @@ func main() { [[Back to top]](#) ## update-multi-host-sources -Update Multi-Host Integration +Update multi-host integration Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/NonEmployeeLifecycleManagementAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/NonEmployeeLifecycleManagementAPI.md index c393afe40..f0c43f3e6 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/NonEmployeeLifecycleManagementAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/NonEmployeeLifecycleManagementAPI.md @@ -46,42 +46,42 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-non-employee-request**](#approve-non-employee-request) | **Post** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request -[**create-non-employee-record**](#create-non-employee-record) | **Post** `/non-employee-records` | Create Non-Employee Record -[**create-non-employee-request**](#create-non-employee-request) | **Post** `/non-employee-requests` | Create Non-Employee Request -[**create-non-employee-source**](#create-non-employee-source) | **Post** `/non-employee-sources` | Create Non-Employee Source -[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **Post** `/non-employee-sources/{sourceId}/schema-attributes` | Create Non-Employee Source Schema Attribute -[**delete-non-employee-record**](#delete-non-employee-record) | **Delete** `/non-employee-records/{id}` | Delete Non-Employee Record -[**delete-non-employee-record-in-bulk**](#delete-non-employee-record-in-bulk) | **Post** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records -[**delete-non-employee-request**](#delete-non-employee-request) | **Delete** `/non-employee-requests/{id}` | Delete Non-Employee Request -[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete Non-Employee Source's Schema Attribute -[**delete-non-employee-source**](#delete-non-employee-source) | **Delete** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source +[**approve-non-employee-request**](#approve-non-employee-request) | **Post** `/non-employee-approvals/{id}/approve` | Approve a non-employee request +[**create-non-employee-record**](#create-non-employee-record) | **Post** `/non-employee-records` | Create non-employee record +[**create-non-employee-request**](#create-non-employee-request) | **Post** `/non-employee-requests` | Create non-employee request +[**create-non-employee-source**](#create-non-employee-source) | **Post** `/non-employee-sources` | Create non-employee source +[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **Post** `/non-employee-sources/{sourceId}/schema-attributes` | Create non-employee source schema attribute +[**delete-non-employee-record**](#delete-non-employee-record) | **Delete** `/non-employee-records/{id}` | Delete non-employee record +[**delete-non-employee-record-in-bulk**](#delete-non-employee-record-in-bulk) | **Post** `/non-employee-records/bulk-delete` | Delete multiple non-employee records +[**delete-non-employee-request**](#delete-non-employee-request) | **Delete** `/non-employee-requests/{id}` | Delete non-employee request +[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete non-employee source's schema attribute +[**delete-non-employee-source**](#delete-non-employee-source) | **Delete** `/non-employee-sources/{sourceId}` | Delete non-employee source [**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes -[**export-non-employee-records**](#export-non-employee-records) | **Get** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV -[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **Get** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**export-non-employee-records**](#export-non-employee-records) | **Get** `/non-employee-sources/{id}/non-employees/download` | Exports non-employee records to csv +[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **Get** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports source schema template [**get-non-employee-approval**](#get-non-employee-approval) | **Get** `/non-employee-approvals/{id}` | Get a non-employee approval item detail -[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **Get** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests +[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **Get** `/non-employee-approvals/summary/{requested-for}` | Get summary of non-employee approval requests [**get-non-employee-bulk-upload-status**](#get-non-employee-bulk-upload-status) | **Get** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Bulk upload status on source -[**get-non-employee-record**](#get-non-employee-record) | **Get** `/non-employee-records/{id}` | Get a Non-Employee Record -[**get-non-employee-request**](#get-non-employee-request) | **Get** `/non-employee-requests/{id}` | Get a Non-Employee Request -[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **Get** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests -[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **Get** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source -[**get-non-employee-source**](#get-non-employee-source) | **Get** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source -[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **Get** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source -[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **Post** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records -[**list-non-employee-approval**](#list-non-employee-approval) | **Get** `/non-employee-approvals` | Get List of Non-Employee Approval Requests -[**list-non-employee-records**](#list-non-employee-records) | **Get** `/non-employee-records` | List Non-Employee Records -[**list-non-employee-requests**](#list-non-employee-requests) | **Get** `/non-employee-requests` | List Non-Employee Requests -[**list-non-employee-sources**](#list-non-employee-sources) | **Get** `/non-employee-sources` | List Non-Employee Sources -[**patch-non-employee-record**](#patch-non-employee-record) | **Patch** `/non-employee-records/{id}` | Patch Non-Employee Record -[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **Patch** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch Non-Employee Source's Schema Attribute -[**patch-non-employee-source**](#patch-non-employee-source) | **Patch** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source -[**reject-non-employee-request**](#reject-non-employee-request) | **Post** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request -[**update-non-employee-record**](#update-non-employee-record) | **Put** `/non-employee-records/{id}` | Update Non-Employee Record +[**get-non-employee-record**](#get-non-employee-record) | **Get** `/non-employee-records/{id}` | Get a non-employee record +[**get-non-employee-request**](#get-non-employee-request) | **Get** `/non-employee-requests/{id}` | Get a non-employee request +[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **Get** `/non-employee-requests/summary/{requested-for}` | Get summary of non-employee requests +[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **Get** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get schema attribute non-employee source +[**get-non-employee-source**](#get-non-employee-source) | **Get** `/non-employee-sources/{sourceId}` | Get a non-employee source +[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **Get** `/non-employee-sources/{sourceId}/schema-attributes` | List schema attributes non-employee source +[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **Post** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or updates, non-employee records +[**list-non-employee-approval**](#list-non-employee-approval) | **Get** `/non-employee-approvals` | Get list of non-employee approval requests +[**list-non-employee-records**](#list-non-employee-records) | **Get** `/non-employee-records` | List non-employee records +[**list-non-employee-requests**](#list-non-employee-requests) | **Get** `/non-employee-requests` | List non-employee requests +[**list-non-employee-sources**](#list-non-employee-sources) | **Get** `/non-employee-sources` | List non-employee sources +[**patch-non-employee-record**](#patch-non-employee-record) | **Patch** `/non-employee-records/{id}` | Patch non-employee record +[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **Patch** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch non-employee source's schema attribute +[**patch-non-employee-source**](#patch-non-employee-source) | **Patch** `/non-employee-sources/{sourceId}` | Patch a non-employee source +[**reject-non-employee-request**](#reject-non-employee-request) | **Post** `/non-employee-approvals/{id}/reject` | Reject a non-employee request +[**update-non-employee-record**](#update-non-employee-record) | **Put** `/non-employee-records/{id}` | Update non-employee record ## approve-non-employee-request -Approve a Non-Employee Request +Approve a non-employee request Approves a non-employee approval request and notifies the next approver. [API Spec](https://developer.sailpoint.com/docs/api/beta/approve-non-employee-request) @@ -156,7 +156,7 @@ func main() { [[Back to top]](#) ## create-non-employee-record -Create Non-Employee Record +Create non-employee record This request will create a non-employee record. Request will require the following security scope: 'idn:nesr:create' @@ -239,7 +239,7 @@ func main() { [[Back to top]](#) ## create-non-employee-request -Create Non-Employee Request +Create non-employee request This request will create a non-employee request and notify the approver [API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-request) @@ -320,7 +320,7 @@ func main() { [[Back to top]](#) ## create-non-employee-source -Create Non-Employee Source +Create non-employee source Create a non-employee source. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source) @@ -412,7 +412,7 @@ func main() { [[Back to top]](#) ## create-non-employee-source-schema-attributes -Create Non-Employee Source Schema Attribute +Create non-employee source schema attribute This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source-schema-attributes) @@ -492,7 +492,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-record -Delete Non-Employee Record +Delete non-employee record This request will delete a non-employee record. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-record) @@ -557,7 +557,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-record-in-bulk -Delete Multiple Non-Employee Records +Delete multiple non-employee records This request will delete multiple non-employee records based on the non-employee ids provided. Request will require the following scope: 'idn:nesr:delete' @@ -625,7 +625,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-request -Delete Non-Employee Request +Delete non-employee request This request will delete a non-employee request. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-request) @@ -690,7 +690,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-schema-attribute -Delete Non-Employee Source's Schema Attribute +Delete non-employee source's schema attribute This end-point deletes a specific schema attribute for a non-employee source. @@ -759,7 +759,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-source -Delete Non-Employee Source +Delete non-employee source This request will delete a non-employee source. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-source) @@ -889,7 +889,7 @@ func main() { [[Back to top]](#) ## export-non-employee-records -Exports Non-Employee Records to CSV +Exports non-employee records to csv This requests a CSV download for all non-employees from a provided source. [API Spec](https://developer.sailpoint.com/docs/api/beta/export-non-employee-records) @@ -954,7 +954,7 @@ func main() { [[Back to top]](#) ## export-non-employee-source-schema-template -Exports Source Schema Template +Exports source schema template This requests a download for the Source Schema Template for a provided source. Request will require the following security scope: idn:nesr:read' @@ -1089,7 +1089,7 @@ func main() { [[Back to top]](#) ## get-non-employee-approval-summary -Get Summary of Non-Employee Approval Requests +Get summary of non-employee approval requests This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. 2. The current user is an approver, in which case "me" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-approval-summary) @@ -1222,7 +1222,7 @@ func main() { [[Back to top]](#) ## get-non-employee-record -Get a Non-Employee Record +Get a non-employee record This gets a non-employee record. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-record) @@ -1288,7 +1288,7 @@ func main() { [[Back to top]](#) ## get-non-employee-request -Get a Non-Employee Request +Get a non-employee request This gets a non-employee request. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-request) @@ -1354,7 +1354,7 @@ func main() { [[Back to top]](#) ## get-non-employee-request-summary -Get Summary of Non-Employee Requests +Get summary of non-employee requests This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-request-summary) @@ -1420,7 +1420,7 @@ func main() { [[Back to top]](#) ## get-non-employee-schema-attribute -Get Schema Attribute Non-Employee Source +Get schema attribute non-employee source This API gets a schema attribute by Id for the specified Non-Employee SourceId. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-schema-attribute) @@ -1489,7 +1489,7 @@ func main() { [[Back to top]](#) ## get-non-employee-source -Get a Non-Employee Source +Get a non-employee source This gets a non-employee source. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-source) @@ -1555,7 +1555,7 @@ func main() { [[Back to top]](#) ## get-non-employee-source-schema-attributes -List Schema Attributes Non-Employee Source +List schema attributes non-employee source This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-source-schema-attributes) @@ -1621,7 +1621,7 @@ func main() { [[Back to top]](#) ## import-non-employee-records-in-bulk -Imports, or Updates, Non-Employee Records +Imports, or updates, non-employee records This post will import, or update, Non-Employee records found in the CSV. Request will need the following security scope: 'idn:nesr:create' @@ -1691,7 +1691,7 @@ func main() { [[Back to top]](#) ## list-non-employee-approval -Get List of Non-Employee Approval Requests +Get list of non-employee approval requests This gets a list of non-employee approval requests. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-approval) @@ -1763,7 +1763,7 @@ func main() { [[Back to top]](#) ## list-non-employee-records -List Non-Employee Records +List non-employee records This gets a list of non-employee records. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-records) @@ -1833,7 +1833,7 @@ func main() { [[Back to top]](#) ## list-non-employee-requests -List Non-Employee Requests +List non-employee requests This gets a list of non-employee requests. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-requests) @@ -1905,7 +1905,7 @@ func main() { [[Back to top]](#) ## list-non-employee-sources -List Non-Employee Sources +List non-employee sources Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. @@ -1979,7 +1979,7 @@ func main() { [[Back to top]](#) ## patch-non-employee-record -Patch Non-Employee Record +Patch non-employee record This request will patch a non-employee record. [API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-record) @@ -2052,7 +2052,7 @@ func main() { [[Back to top]](#) ## patch-non-employee-schema-attribute -Patch Non-Employee Source's Schema Attribute +Patch non-employee source's schema attribute This end-point patches a specific schema attribute for a non-employee SourceId. @@ -2129,7 +2129,7 @@ func main() { [[Back to top]](#) ## patch-non-employee-source -Patch a Non-Employee Source +Patch a non-employee source patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers** [API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-source) @@ -2202,7 +2202,7 @@ func main() { [[Back to top]](#) ## reject-non-employee-request -Reject a Non-Employee Request +Reject a non-employee request This endpoint will reject an approval item request and notify user. [API Spec](https://developer.sailpoint.com/docs/api/beta/reject-non-employee-request) @@ -2277,7 +2277,7 @@ func main() { [[Back to top]](#) ## update-non-employee-record -Update Non-Employee Record +Update non-employee record This request will update a non-employee record. [API Spec](https://developer.sailpoint.com/docs/api/beta/update-non-employee-record) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/NotificationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/NotificationsAPI.md index 705f1a026..a15411177 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/NotificationsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/NotificationsAPI.md @@ -15,25 +15,25 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-domain-dkim**](#create-domain-dkim) | **Post** `/verified-domains` | Verify domain address via DKIM -[**create-notification-template**](#create-notification-template) | **Post** `/notification-templates` | Create Notification Template -[**create-verified-from-address**](#create-verified-from-address) | **Post** `/verified-from-addresses` | Create Verified From Address -[**delete-notification-templates-in-bulk**](#delete-notification-templates-in-bulk) | **Post** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates -[**delete-verified-from-address**](#delete-verified-from-address) | **Delete** `/verified-from-addresses/{id}` | Delete Verified From Address -[**get-dkim-attributes**](#get-dkim-attributes) | **Get** `/verified-domains` | Get DKIM Attributes -[**get-mail-from-attributes**](#get-mail-from-attributes) | **Get** `/mail-from-attributes/{identityId}` | Get MAIL FROM Attributes -[**get-notification-template**](#get-notification-template) | **Get** `/notification-templates/{id}` | Get Notification Template By Id -[**get-notifications-template-context**](#get-notifications-template-context) | **Get** `/notification-template-context` | Get Notification Template Context -[**list-from-addresses**](#list-from-addresses) | **Get** `/verified-from-addresses` | List From Addresses -[**list-notification-preferences**](#list-notification-preferences) | **Get** `/notification-preferences/{key}` | List Notification Preferences for tenant. -[**list-notification-template-defaults**](#list-notification-template-defaults) | **Get** `/notification-template-defaults` | List Notification Template Defaults -[**list-notification-templates**](#list-notification-templates) | **Get** `/notification-templates` | List Notification Templates -[**put-mail-from-attributes**](#put-mail-from-attributes) | **Put** `/mail-from-attributes` | Change MAIL FROM domain -[**send-test-notification**](#send-test-notification) | **Post** `/send-test-notification` | Send Test Notification +[**create-domain-dkim**](#create-domain-dkim) | **Post** `/verified-domains` | Verify domain address via dkim +[**create-notification-template**](#create-notification-template) | **Post** `/notification-templates` | Create notification template +[**create-verified-from-address**](#create-verified-from-address) | **Post** `/verified-from-addresses` | Create verified from address +[**delete-notification-templates-in-bulk**](#delete-notification-templates-in-bulk) | **Post** `/notification-templates/bulk-delete` | Bulk delete notification templates +[**delete-verified-from-address**](#delete-verified-from-address) | **Delete** `/verified-from-addresses/{id}` | Delete verified from address +[**get-dkim-attributes**](#get-dkim-attributes) | **Get** `/verified-domains` | Get dkim attributes +[**get-mail-from-attributes**](#get-mail-from-attributes) | **Get** `/mail-from-attributes/{identityId}` | Get mail from attributes +[**get-notification-template**](#get-notification-template) | **Get** `/notification-templates/{id}` | Get notification template by id +[**get-notifications-template-context**](#get-notifications-template-context) | **Get** `/notification-template-context` | Get notification template context +[**list-from-addresses**](#list-from-addresses) | **Get** `/verified-from-addresses` | List from addresses +[**list-notification-preferences**](#list-notification-preferences) | **Get** `/notification-preferences/{key}` | List notification preferences for tenant. +[**list-notification-template-defaults**](#list-notification-template-defaults) | **Get** `/notification-template-defaults` | List notification template defaults +[**list-notification-templates**](#list-notification-templates) | **Get** `/notification-templates` | List notification templates +[**put-mail-from-attributes**](#put-mail-from-attributes) | **Put** `/mail-from-attributes` | Change mail from domain +[**send-test-notification**](#send-test-notification) | **Post** `/send-test-notification` | Send test notification ## create-domain-dkim -Verify domain address via DKIM +Verify domain address via dkim Create a domain to be verified via DKIM (DomainKeys Identified Mail) [API Spec](https://developer.sailpoint.com/docs/api/beta/create-domain-dkim) @@ -102,7 +102,7 @@ func main() { [[Back to top]](#) ## create-notification-template -Create Notification Template +Create notification template This creates a template for your site. You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. @@ -188,7 +188,7 @@ func main() { [[Back to top]](#) ## create-verified-from-address -Create Verified From Address +Create verified from address Create a new sender email address and initiate verification process. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-verified-from-address) @@ -260,7 +260,7 @@ func main() { [[Back to top]](#) ## delete-notification-templates-in-bulk -Bulk Delete Notification Templates +Bulk delete notification templates This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-notification-templates-in-bulk) @@ -326,7 +326,7 @@ func main() { [[Back to top]](#) ## delete-verified-from-address -Delete Verified From Address +Delete verified from address Delete a verified sender email address [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-verified-from-address) @@ -391,7 +391,7 @@ func main() { [[Back to top]](#) ## get-dkim-attributes -Get DKIM Attributes +Get dkim attributes Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-dkim-attributes) @@ -448,7 +448,7 @@ func main() { [[Back to top]](#) ## get-mail-from-attributes -Get MAIL FROM Attributes +Get mail from attributes Retrieve MAIL FROM attributes for a given AWS SES identity. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-mail-from-attributes) @@ -514,7 +514,7 @@ func main() { [[Back to top]](#) ## get-notification-template -Get Notification Template By Id +Get notification template by id This gets a template that you have modified for your site by Id. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-notification-template) @@ -580,7 +580,7 @@ func main() { [[Back to top]](#) ## get-notifications-template-context -Get Notification Template Context +Get notification template context The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). @@ -638,7 +638,7 @@ func main() { [[Back to top]](#) ## list-from-addresses -List From Addresses +List from addresses Retrieve a list of sender email addresses and their verification statuses [API Spec](https://developer.sailpoint.com/docs/api/beta/list-from-addresses) @@ -708,7 +708,7 @@ func main() { [[Back to top]](#) ## list-notification-preferences -List Notification Preferences for tenant. +List notification preferences for tenant. Returns a list of notification preferences for tenant. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-preferences) @@ -774,7 +774,7 @@ func main() { [[Back to top]](#) ## list-notification-template-defaults -List Notification Template Defaults +List notification template defaults This lists the default templates used for notifications, such as emails from IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-template-defaults) @@ -840,7 +840,7 @@ func main() { [[Back to top]](#) ## list-notification-templates -List Notification Templates +List notification templates This lists the templates that you have modified for your site. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-templates) @@ -906,7 +906,7 @@ func main() { [[Back to top]](#) ## put-mail-from-attributes -Change MAIL FROM domain +Change mail from domain Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS [API Spec](https://developer.sailpoint.com/docs/api/beta/put-mail-from-attributes) @@ -976,7 +976,7 @@ func main() { [[Back to top]](#) ## send-test-notification -Send Test Notification +Send test notification Send a Test Notification [API Spec](https://developer.sailpoint.com/docs/api/beta/send-test-notification) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/OAuthClientsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/OAuthClientsAPI.md index 5401d055a..354dc0a92 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/OAuthClientsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/OAuthClientsAPI.md @@ -18,15 +18,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-oauth-client**](#create-oauth-client) | **Post** `/oauth-clients` | Create OAuth Client -[**delete-oauth-client**](#delete-oauth-client) | **Delete** `/oauth-clients/{id}` | Delete OAuth Client -[**get-oauth-client**](#get-oauth-client) | **Get** `/oauth-clients/{id}` | Get OAuth Client -[**list-oauth-clients**](#list-oauth-clients) | **Get** `/oauth-clients` | List OAuth Clients -[**patch-oauth-client**](#patch-oauth-client) | **Patch** `/oauth-clients/{id}` | Patch OAuth Client +[**create-oauth-client**](#create-oauth-client) | **Post** `/oauth-clients` | Create oauth client +[**delete-oauth-client**](#delete-oauth-client) | **Delete** `/oauth-clients/{id}` | Delete oauth client +[**get-oauth-client**](#get-oauth-client) | **Get** `/oauth-clients/{id}` | Get oauth client +[**list-oauth-clients**](#list-oauth-clients) | **Get** `/oauth-clients` | List oauth clients +[**patch-oauth-client**](#patch-oauth-client) | **Patch** `/oauth-clients/{id}` | Patch oauth client ## create-oauth-client -Create OAuth Client +Create oauth client This creates an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-oauth-client) @@ -109,7 +109,7 @@ func main() { [[Back to top]](#) ## delete-oauth-client -Delete OAuth Client +Delete oauth client This deletes an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-oauth-client) @@ -174,7 +174,7 @@ func main() { [[Back to top]](#) ## get-oauth-client -Get OAuth Client +Get oauth client This gets details of an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-oauth-client) @@ -240,7 +240,7 @@ func main() { [[Back to top]](#) ## list-oauth-clients -List OAuth Clients +List oauth clients This gets a list of OAuth clients. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-oauth-clients) @@ -302,7 +302,7 @@ func main() { [[Back to top]](#) ## patch-oauth-client -Patch OAuth Client +Patch oauth client This performs a targeted update to the field(s) of an OAuth client. Request will require a security scope of - sp:oauth-client:manage diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/OrgConfigAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/OrgConfigAPI.md index 5b56648e1..4458468bc 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/OrgConfigAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/OrgConfigAPI.md @@ -17,13 +17,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-org-config**](#get-org-config) | **Get** `/org-config` | Get Org configuration settings +[**get-org-config**](#get-org-config) | **Get** `/org-config` | Get org configuration settings [**get-valid-time-zones**](#get-valid-time-zones) | **Get** `/org-config/valid-time-zones` | Get list of time zones -[**patch-org-config**](#patch-org-config) | **Patch** `/org-config` | Patch an Org configuration property +[**patch-org-config**](#patch-org-config) | **Patch** `/org-config` | Patch an org configuration property ## get-org-config -Get Org configuration settings +Get org configuration settings Get org configuration with only external (org admin) accessible properties for the current org. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-org-config) @@ -137,7 +137,7 @@ func main() { [[Back to top]](#) ## patch-org-config -Patch an Org configuration property +Patch an org configuration property Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org. [API Spec](https://developer.sailpoint.com/docs/api/beta/patch-org-config) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordConfigurationAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordConfigurationAPI.md index 343ccb587..e5d03e9d6 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordConfigurationAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordConfigurationAPI.md @@ -21,13 +21,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-password-org-config**](#create-password-org-config) | **Post** `/password-org-config` | Create Password Org Config -[**get-password-org-config**](#get-password-org-config) | **Get** `/password-org-config` | Get Password Org Config -[**put-password-org-config**](#put-password-org-config) | **Put** `/password-org-config` | Update Password Org Config +[**create-password-org-config**](#create-password-org-config) | **Post** `/password-org-config` | Create password org config +[**get-password-org-config**](#get-password-org-config) | **Get** `/password-org-config` | Get password org config +[**put-password-org-config**](#put-password-org-config) | **Put** `/password-org-config` | Update password org config ## create-password-org-config -Create Password Org Config +Create password org config This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' @@ -101,7 +101,7 @@ func main() { [[Back to top]](#) ## get-password-org-config -Get Password Org Config +Get password org config This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' [API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-org-config) @@ -158,7 +158,7 @@ func main() { [[Back to top]](#) ## put-password-org-config -Update Password Org Config +Update password org config This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordDictionaryAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordDictionaryAPI.md index bbdaaff4e..b7f3a3376 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordDictionaryAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordDictionaryAPI.md @@ -62,12 +62,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-password-dictionary**](#get-password-dictionary) | **Get** `/password-dictionary` | Get Password Dictionary -[**put-password-dictionary**](#put-password-dictionary) | **Put** `/password-dictionary` | Update Password Dictionary +[**get-password-dictionary**](#get-password-dictionary) | **Get** `/password-dictionary` | Get password dictionary +[**put-password-dictionary**](#put-password-dictionary) | **Put** `/password-dictionary` | Update password dictionary ## get-password-dictionary -Get Password Dictionary +Get password dictionary This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing @@ -152,7 +152,7 @@ func main() { [[Back to top]](#) ## put-password-dictionary -Update Password Dictionary +Update password dictionary This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordManagementAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordManagementAPI.md index 86e3d2f8b..b431606f3 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordManagementAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordManagementAPI.md @@ -40,9 +40,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-digit-token**](#create-digit-token) | **Post** `/generate-password-reset-token/digit` | Generate a digit token -[**get-identity-password-change-status**](#get-identity-password-change-status) | **Get** `/password-change-status/{id}` | Get Password Change Request Status -[**query-password-info**](#query-password-info) | **Post** `/query-password-info` | Query Password Info -[**set-identity-password**](#set-identity-password) | **Post** `/set-password` | Set Identity's Password +[**get-identity-password-change-status**](#get-identity-password-change-status) | **Get** `/password-change-status/{id}` | Get password change request status +[**query-password-info**](#query-password-info) | **Post** `/query-password-info` | Query password info +[**set-identity-password**](#set-identity-password) | **Post** `/set-password` | Set identity's password ## create-digit-token @@ -117,7 +117,7 @@ func main() { [[Back to top]](#) ## get-identity-password-change-status -Get Password Change Request Status +Get password change request status This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-password-change-status) @@ -183,7 +183,7 @@ func main() { [[Back to top]](#) ## query-password-info -Query Password Info +Query password info This API is used to query password related information. A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) @@ -261,7 +261,7 @@ func main() { [[Back to top]](#) ## set-identity-password -Set Identity's Password +Set identity's password This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordPoliciesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordPoliciesAPI.md index db7757109..2e210c512 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordPoliciesAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordPoliciesAPI.md @@ -24,15 +24,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-password-policy**](#create-password-policy) | **Post** `/password-policies` | Create Password Policy -[**delete-password-policy**](#delete-password-policy) | **Delete** `/password-policies/{id}` | Delete Password Policy by ID -[**get-password-policy-by-id**](#get-password-policy-by-id) | **Get** `/password-policies/{id}` | Get Password Policy by ID -[**list-password-policies**](#list-password-policies) | **Get** `/password-policies` | List Password Policies -[**set-password-policy**](#set-password-policy) | **Put** `/password-policies/{id}` | Update Password Policy by ID +[**create-password-policy**](#create-password-policy) | **Post** `/password-policies` | Create password policy +[**delete-password-policy**](#delete-password-policy) | **Delete** `/password-policies/{id}` | Delete password policy by id +[**get-password-policy-by-id**](#get-password-policy-by-id) | **Get** `/password-policies/{id}` | Get password policy by id +[**list-password-policies**](#list-password-policies) | **Get** `/password-policies` | List password policies +[**set-password-policy**](#set-password-policy) | **Put** `/password-policies/{id}` | Update password policy by id ## create-password-policy -Create Password Policy +Create password policy This API creates the specified password policy. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-password-policy) @@ -131,7 +131,7 @@ func main() { [[Back to top]](#) ## delete-password-policy -Delete Password Policy by ID +Delete password policy by id This API deletes the specified password policy. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-password-policy) @@ -196,7 +196,7 @@ func main() { [[Back to top]](#) ## get-password-policy-by-id -Get Password Policy by ID +Get password policy by id This API returns the password policy for the specified ID. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-policy-by-id) @@ -262,7 +262,7 @@ func main() { [[Back to top]](#) ## list-password-policies -List Password Policies +List password policies This gets list of all Password Policies. Requires role of ORG_ADMIN @@ -329,7 +329,7 @@ func main() { [[Back to top]](#) ## set-password-policy -Update Password Policy by ID +Update password policy by id This API updates the specified password policy. [API Spec](https://developer.sailpoint.com/docs/api/beta/set-password-policy) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordSyncGroupsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordSyncGroupsAPI.md index 9bd2e5799..ac0638ddc 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordSyncGroupsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordSyncGroupsAPI.md @@ -47,15 +47,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-password-sync-group**](#create-password-sync-group) | **Post** `/password-sync-groups` | Create Password Sync Group -[**delete-password-sync-group**](#delete-password-sync-group) | **Delete** `/password-sync-groups/{id}` | Delete Password Sync Group by ID -[**get-password-sync-group**](#get-password-sync-group) | **Get** `/password-sync-groups/{id}` | Get Password Sync Group by ID -[**get-password-sync-groups**](#get-password-sync-groups) | **Get** `/password-sync-groups` | Get Password Sync Group List -[**update-password-sync-group**](#update-password-sync-group) | **Put** `/password-sync-groups/{id}` | Update Password Sync Group by ID +[**create-password-sync-group**](#create-password-sync-group) | **Post** `/password-sync-groups` | Create password sync group +[**delete-password-sync-group**](#delete-password-sync-group) | **Delete** `/password-sync-groups/{id}` | Delete password sync group by id +[**get-password-sync-group**](#get-password-sync-group) | **Get** `/password-sync-groups/{id}` | Get password sync group by id +[**get-password-sync-groups**](#get-password-sync-groups) | **Get** `/password-sync-groups` | Get password sync group list +[**update-password-sync-group**](#update-password-sync-group) | **Put** `/password-sync-groups/{id}` | Update password sync group by id ## create-password-sync-group -Create Password Sync Group +Create password sync group This API creates a password sync group based on the specifications provided. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-password-sync-group) @@ -129,7 +129,7 @@ func main() { [[Back to top]](#) ## delete-password-sync-group -Delete Password Sync Group by ID +Delete password sync group by id This API deletes the specified password sync group. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-password-sync-group) @@ -194,7 +194,7 @@ func main() { [[Back to top]](#) ## get-password-sync-group -Get Password Sync Group by ID +Get password sync group by id This API returns the sync group for the specified ID. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-sync-group) @@ -260,7 +260,7 @@ func main() { [[Back to top]](#) ## get-password-sync-groups -Get Password Sync Group List +Get password sync group list This API returns a list of password sync groups. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-sync-groups) @@ -326,7 +326,7 @@ func main() { [[Back to top]](#) ## update-password-sync-group -Update Password Sync Group by ID +Update password sync group by id This API updates the specified password sync group. [API Spec](https://developer.sailpoint.com/docs/api/beta/update-password-sync-group) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PersonalAccessTokensAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PersonalAccessTokensAPI.md index f467bcbc2..1fbe9b793 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/PersonalAccessTokensAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PersonalAccessTokensAPI.md @@ -26,14 +26,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-personal-access-token**](#create-personal-access-token) | **Post** `/personal-access-tokens` | Create Personal Access Token -[**delete-personal-access-token**](#delete-personal-access-token) | **Delete** `/personal-access-tokens/{id}` | Delete Personal Access Token -[**list-personal-access-tokens**](#list-personal-access-tokens) | **Get** `/personal-access-tokens` | List Personal Access Tokens -[**patch-personal-access-token**](#patch-personal-access-token) | **Patch** `/personal-access-tokens/{id}` | Patch Personal Access Token +[**create-personal-access-token**](#create-personal-access-token) | **Post** `/personal-access-tokens` | Create personal access token +[**delete-personal-access-token**](#delete-personal-access-token) | **Delete** `/personal-access-tokens/{id}` | Delete personal access token +[**list-personal-access-tokens**](#list-personal-access-tokens) | **Get** `/personal-access-tokens` | List personal access tokens +[**patch-personal-access-token**](#patch-personal-access-token) | **Patch** `/personal-access-tokens/{id}` | Patch personal access token ## create-personal-access-token -Create Personal Access Token +Create personal access token This creates a personal access token. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-personal-access-token) @@ -104,7 +104,7 @@ func main() { [[Back to top]](#) ## delete-personal-access-token -Delete Personal Access Token +Delete personal access token This deletes a personal access token. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-personal-access-token) @@ -169,7 +169,7 @@ func main() { [[Back to top]](#) ## list-personal-access-tokens -List Personal Access Tokens +List personal access tokens This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-personal-access-tokens) @@ -233,7 +233,7 @@ func main() { [[Back to top]](#) ## patch-personal-access-token -Patch Personal Access Token +Patch personal access token This performs a targeted update to the field(s) of a Personal Access Token. [API Spec](https://developer.sailpoint.com/docs/api/beta/patch-personal-access-token) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PublicIdentitiesConfigAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PublicIdentitiesConfigAPI.md index 44bdbb435..92b92fc16 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/PublicIdentitiesConfigAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PublicIdentitiesConfigAPI.md @@ -25,15 +25,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-public-identity-config**](#get-public-identity-config) | **Get** `/public-identities-config` | Get Public Identity Config -[**update-public-identity-config**](#update-public-identity-config) | **Put** `/public-identities-config` | Update Public Identity Config +[**get-public-identity-config**](#get-public-identity-config) | **Get** `/public-identities-config` | Get public identity config +[**update-public-identity-config**](#update-public-identity-config) | **Put** `/public-identities-config` | Update public identity config ## get-public-identity-config :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Get Public Identity Config +Get public identity config This gets details of public identity config. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-public-identity-config) @@ -93,7 +93,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Update Public Identity Config +Update public identity config This updates the details of public identity config. [API Spec](https://developer.sailpoint.com/docs/api/beta/update-public-identity-config) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/RequestableObjectsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/RequestableObjectsAPI.md index 75026b6ed..c5638ee9f 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/RequestableObjectsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/RequestableObjectsAPI.md @@ -18,11 +18,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**list-requestable-objects**](#list-requestable-objects) | **Get** `/requestable-objects` | Requestable Objects List +[**list-requestable-objects**](#list-requestable-objects) | **Get** `/requestable-objects` | Requestable objects list ## list-requestable-objects -Requestable Objects List +Requestable objects list Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/RolesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/RolesAPI.md index b3103e2c1..04416d163 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/RolesAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/RolesAPI.md @@ -52,18 +52,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-role**](#create-role) | **Post** `/roles` | Create a Role -[**delete-bulk-roles**](#delete-bulk-roles) | **Post** `/roles/bulk-delete` | Delete Role(s) -[**delete-role**](#delete-role) | **Delete** `/roles/{id}` | Delete a Role -[**get-role**](#get-role) | **Get** `/roles/{id}` | Get a Role -[**get-role-assigned-identities**](#get-role-assigned-identities) | **Get** `/roles/{id}/assigned-identities` | Identities assigned a Role -[**get-role-entitlements**](#get-role-entitlements) | **Get** `/roles/{id}/entitlements` | List Role's Entitlements -[**list-roles**](#list-roles) | **Get** `/roles` | List Roles -[**patch-role**](#patch-role) | **Patch** `/roles/{id}` | Patch a specified Role +[**create-role**](#create-role) | **Post** `/roles` | Create a role +[**delete-bulk-roles**](#delete-bulk-roles) | **Post** `/roles/bulk-delete` | Delete role(s) +[**delete-role**](#delete-role) | **Delete** `/roles/{id}` | Delete a role +[**get-role**](#get-role) | **Get** `/roles/{id}` | Get a role +[**get-role-assigned-identities**](#get-role-assigned-identities) | **Get** `/roles/{id}/assigned-identities` | Identities assigned a role +[**get-role-entitlements**](#get-role-entitlements) | **Get** `/roles/{id}/entitlements` | List role's entitlements +[**list-roles**](#list-roles) | **Get** `/roles` | List roles +[**patch-role**](#patch-role) | **Patch** `/roles/{id}` | Patch a specified role ## create-role -Create a Role +Create a role This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. @@ -294,7 +294,7 @@ func main() { [[Back to top]](#) ## delete-bulk-roles -Delete Role(s) +Delete role(s) This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. @@ -366,7 +366,7 @@ func main() { [[Back to top]](#) ## delete-role -Delete a Role +Delete a role This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. @@ -433,7 +433,7 @@ func main() { [[Back to top]](#) ## get-role -Get a Role +Get a role This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. @@ -500,7 +500,7 @@ func main() { [[Back to top]](#) ## get-role-assigned-identities -Identities assigned a Role +Identities assigned a role [API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-assigned-identities) @@ -576,7 +576,7 @@ func main() { [[Back to top]](#) ## get-role-entitlements -List Role's Entitlements +List role's entitlements Get a list of entitlements associated with a specified role. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-entitlements) @@ -652,7 +652,7 @@ func main() { [[Back to top]](#) ## list-roles -List Roles +List roles This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. @@ -730,7 +730,7 @@ func main() { [[Back to top]](#) ## patch-role -Patch a specified Role +Patch a specified role This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SIMIntegrationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SIMIntegrationsAPI.md index 53c7be07c..5d915d4f5 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/SIMIntegrationsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SIMIntegrationsAPI.md @@ -22,17 +22,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-sim-integration**](#create-sim-integration) | **Post** `/sim-integrations` | Create new SIM integration -[**delete-sim-integration**](#delete-sim-integration) | **Delete** `/sim-integrations/{id}` | Delete a SIM integration -[**get-sim-integration**](#get-sim-integration) | **Get** `/sim-integrations/{id}` | Get a SIM integration details. -[**get-sim-integrations**](#get-sim-integrations) | **Get** `/sim-integrations` | List the existing SIM integrations. -[**patch-before-provisioning-rule**](#patch-before-provisioning-rule) | **Patch** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute. -[**patch-sim-attributes**](#patch-sim-attributes) | **Patch** `/sim-integrations/{id}` | Patch a SIM attribute. -[**put-sim-integration**](#put-sim-integration) | **Put** `/sim-integrations/{id}` | Update an existing SIM integration +[**create-sim-integration**](#create-sim-integration) | **Post** `/sim-integrations` | Create new sim integration +[**delete-sim-integration**](#delete-sim-integration) | **Delete** `/sim-integrations/{id}` | Delete a sim integration +[**get-sim-integration**](#get-sim-integration) | **Get** `/sim-integrations/{id}` | Get a sim integration details. +[**get-sim-integrations**](#get-sim-integrations) | **Get** `/sim-integrations` | List the existing sim integrations. +[**patch-before-provisioning-rule**](#patch-before-provisioning-rule) | **Patch** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a sim beforeprovisioningrule attribute. +[**patch-sim-attributes**](#patch-sim-attributes) | **Patch** `/sim-integrations/{id}` | Patch a sim attribute. +[**put-sim-integration**](#put-sim-integration) | **Put** `/sim-integrations/{id}` | Update an existing sim integration ## create-sim-integration -Create new SIM integration +Create new sim integration Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-sim-integration) @@ -116,7 +116,7 @@ func main() { [[Back to top]](#) ## delete-sim-integration -Delete a SIM integration +Delete a sim integration Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sim-integration) @@ -181,7 +181,7 @@ func main() { [[Back to top]](#) ## get-sim-integration -Get a SIM integration details. +Get a sim integration details. Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-sim-integration) @@ -247,7 +247,7 @@ func main() { [[Back to top]](#) ## get-sim-integrations -List the existing SIM integrations. +List the existing sim integrations. List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-sim-integrations) @@ -304,7 +304,7 @@ func main() { [[Back to top]](#) ## patch-before-provisioning-rule -Patch a SIM beforeProvisioningRule attribute. +Patch a sim beforeprovisioningrule attribute. Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. [API Spec](https://developer.sailpoint.com/docs/api/beta/patch-before-provisioning-rule) @@ -377,7 +377,7 @@ func main() { [[Back to top]](#) ## patch-sim-attributes -Patch a SIM attribute. +Patch a sim attribute. Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. [API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sim-attributes) @@ -450,7 +450,7 @@ func main() { [[Back to top]](#) ## put-sim-integration -Update an existing SIM integration +Update an existing sim integration Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. [API Spec](https://developer.sailpoint.com/docs/api/beta/put-sim-integration) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SODPoliciesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SODPoliciesAPI.md index bd0eed940..09dd7eefa 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/SODPoliciesAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SODPoliciesAPI.md @@ -41,29 +41,29 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-sod-policy**](#create-sod-policy) | **Post** `/sod-policies` | Create SOD policy -[**delete-sod-policy**](#delete-sod-policy) | **Delete** `/sod-policies/{id}` | Delete SOD policy by ID -[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **Delete** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**create-sod-policy**](#create-sod-policy) | **Post** `/sod-policies` | Create sod policy +[**delete-sod-policy**](#delete-sod-policy) | **Delete** `/sod-policies/{id}` | Delete sod policy by id +[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **Delete** `/sod-policies/{id}/schedule` | Delete sod policy schedule [**get-custom-violation-report**](#get-custom-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report [**get-default-violation-report**](#get-default-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download` | Download violation report [**get-sod-all-report-run-status**](#get-sod-all-report-run-status) | **Get** `/sod-violation-report` | Get multi-report run task status -[**get-sod-policy**](#get-sod-policy) | **Get** `/sod-policies/{id}` | Get SOD policy by ID -[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **Get** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**get-sod-policy**](#get-sod-policy) | **Get** `/sod-policies/{id}` | Get sod policy by id +[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **Get** `/sod-policies/{id}/schedule` | Get sod policy schedule [**get-sod-violation-report-run-status**](#get-sod-violation-report-run-status) | **Get** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status -[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **Get** `/sod-policies/{id}/violation-report` | Get SOD violation report status -[**list-sod-policies**](#list-sod-policies) | **Get** `/sod-policies` | List SOD policies -[**patch-sod-policy**](#patch-sod-policy) | **Patch** `/sod-policies/{id}` | Patch a SOD policy -[**put-policy-schedule**](#put-policy-schedule) | **Put** `/sod-policies/{id}/schedule` | Update SOD Policy schedule -[**put-sod-policy**](#put-sod-policy) | **Put** `/sod-policies/{id}` | Update SOD policy by ID +[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **Get** `/sod-policies/{id}/violation-report` | Get sod violation report status +[**list-sod-policies**](#list-sod-policies) | **Get** `/sod-policies` | List sod policies +[**patch-sod-policy**](#patch-sod-policy) | **Patch** `/sod-policies/{id}` | Patch a sod policy +[**put-policy-schedule**](#put-policy-schedule) | **Put** `/sod-policies/{id}/schedule` | Update sod policy schedule +[**put-sod-policy**](#put-sod-policy) | **Put** `/sod-policies/{id}` | Update sod policy by id [**start-sod-all-policies-for-org**](#start-sod-all-policies-for-org) | **Post** `/sod-violation-report/run` | Runs all policies for org -[**start-sod-policy**](#start-sod-policy) | **Post** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report +[**start-sod-policy**](#start-sod-policy) | **Post** `/sod-policies/{id}/violation-report/run` | Runs sod policy violation report ## create-sod-policy :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Create SOD policy +Create sod policy This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. @@ -189,7 +189,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Delete SOD policy by ID +Delete sod policy by id This deletes a specified SOD policy. Requires role of ORG_ADMIN. @@ -260,7 +260,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Delete SOD policy schedule +Delete sod policy schedule This deletes schedule for a specified SOD policy. Requires role of ORG_ADMIN. @@ -533,7 +533,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Get SOD policy by ID +Get sod policy by id This gets specified SOD policy. Requires role of ORG_ADMIN. @@ -603,7 +603,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Get SOD policy schedule +Get sod policy schedule This endpoint gets a specified SOD policy's schedule. Requires the role of ORG_ADMIN. @@ -743,7 +743,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Get SOD violation report status +Get sod violation report status This gets the status for a violation report run task that has already been invoked. Requires role of ORG_ADMIN. @@ -813,7 +813,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -List SOD policies +List sod policies This gets list of all SOD policies. Requires role of ORG_ADMIN @@ -887,7 +887,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Patch a SOD policy +Patch a sod policy Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. @@ -965,7 +965,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Update SOD Policy schedule +Update sod policy schedule This updates schedule for a specified SOD policy. Requires role of ORG_ADMIN. @@ -1127,7 +1127,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Update SOD policy by ID +Update sod policy by id This updates a specified SOD policy. Requires role of ORG_ADMIN. @@ -1327,7 +1327,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Runs SOD policy violation report +Runs sod policy violation report This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. Requires role of ORG_ADMIN. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SODViolationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SODViolationsAPI.md index 8caedde87..73cf7dbc9 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/SODViolationsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SODViolationsAPI.md @@ -33,14 +33,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**start-predict-sod-violations**](#start-predict-sod-violations) | **Post** `/sod-violations/predict` | Predict SOD violations for identity. +[**start-predict-sod-violations**](#start-predict-sod-violations) | **Post** `/sod-violations/predict` | Predict sod violations for identity. ## start-predict-sod-violations :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Predict SOD violations for identity. +Predict sod violations for identity. This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. A token with ORG_ADMIN or API authority is required to call this API. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SPConfigAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SPConfigAPI.md index 2204844df..5d6d56d51 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/SPConfigAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SPConfigAPI.md @@ -21,7 +21,7 @@ Method | HTTP request | Description [**get-sp-config-import**](#get-sp-config-import) | **Get** `/sp-config/import/{id}/download` | Download import job result [**get-sp-config-import-status**](#get-sp-config-import-status) | **Get** `/sp-config/import/{id}` | Get import job status [**import-sp-config**](#import-sp-config) | **Post** `/sp-config/import` | Initiates configuration objects import job -[**list-sp-config-objects**](#list-sp-config-objects) | **Get** `/sp-config/config-objects` | List Config Objects +[**list-sp-config-objects**](#list-sp-config-objects) | **Get** `/sp-config/config-objects` | List config objects ## export-sp-config @@ -442,7 +442,7 @@ func main() { [[Back to top]](#) ## list-sp-config-objects -List Config Objects +List config objects Get a list of object configurations that the tenant export/import service knows. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-sp-config-objects) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SearchAttributeConfigurationAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SearchAttributeConfigurationAPI.md index 5baee2a50..4ab26ba77 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/SearchAttributeConfigurationAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SearchAttributeConfigurationAPI.md @@ -33,15 +33,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-search-attribute-config**](#create-search-attribute-config) | **Post** `/accounts/search-attribute-config` | Create Extended Search Attributes -[**delete-search-attribute-config**](#delete-search-attribute-config) | **Delete** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute -[**get-search-attribute-config**](#get-search-attribute-config) | **Get** `/accounts/search-attribute-config` | List Extended Search Attributes -[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **Get** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute -[**patch-search-attribute-config**](#patch-search-attribute-config) | **Patch** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute +[**create-search-attribute-config**](#create-search-attribute-config) | **Post** `/accounts/search-attribute-config` | Create extended search attributes +[**delete-search-attribute-config**](#delete-search-attribute-config) | **Delete** `/accounts/search-attribute-config/{name}` | Delete extended search attribute +[**get-search-attribute-config**](#get-search-attribute-config) | **Get** `/accounts/search-attribute-config` | List extended search attributes +[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **Get** `/accounts/search-attribute-config/{name}` | Get extended search attribute +[**patch-search-attribute-config**](#patch-search-attribute-config) | **Patch** `/accounts/search-attribute-config/{name}` | Update extended search attribute ## create-search-attribute-config -Create Extended Search Attributes +Create extended search attributes Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** @@ -116,7 +116,7 @@ func main() { [[Back to top]](#) ## delete-search-attribute-config -Delete Extended Search Attribute +Delete extended search attribute Delete an extended attribute configuration by name. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-search-attribute-config) @@ -181,7 +181,7 @@ func main() { [[Back to top]](#) ## get-search-attribute-config -List Extended Search Attributes +List extended search attributes Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). A token with ORG_ADMIN authority is required to call this API. @@ -246,7 +246,7 @@ func main() { [[Back to top]](#) ## get-single-search-attribute-config -Get Extended Search Attribute +Get extended search attribute Get an extended attribute configuration by name. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-single-search-attribute-config) @@ -312,7 +312,7 @@ func main() { [[Back to top]](#) ## patch-search-attribute-config -Update Extended Search Attribute +Update extended search attribute Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SegmentsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SegmentsAPI.md index e920b88bd..f1c674949 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/SegmentsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SegmentsAPI.md @@ -32,15 +32,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-segment**](#create-segment) | **Post** `/segments` | Create Segment -[**delete-segment**](#delete-segment) | **Delete** `/segments/{id}` | Delete Segment by ID -[**get-segment**](#get-segment) | **Get** `/segments/{id}` | Get Segment by ID -[**list-segments**](#list-segments) | **Get** `/segments` | List Segments -[**patch-segment**](#patch-segment) | **Patch** `/segments/{id}` | Update Segment +[**create-segment**](#create-segment) | **Post** `/segments` | Create segment +[**delete-segment**](#delete-segment) | **Delete** `/segments/{id}` | Delete segment by id +[**get-segment**](#get-segment) | **Get** `/segments/{id}` | Get segment by id +[**list-segments**](#list-segments) | **Get** `/segments` | List segments +[**patch-segment**](#patch-segment) | **Patch** `/segments/{id}` | Update segment ## create-segment -Create Segment +Create segment This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API. @@ -132,7 +132,7 @@ func main() { [[Back to top]](#) ## delete-segment -Delete Segment by ID +Delete segment by id This API deletes the segment specified by the given ID. >**Note:** Segment deletion may take some time to go into effect. A token with ORG_ADMIN or API authority is required to call this API. @@ -199,7 +199,7 @@ func main() { [[Back to top]](#) ## get-segment -Get Segment by ID +Get segment by id This API returns the segment specified by the given ID. A token with ORG_ADMIN or API authority is required to call this API. @@ -266,7 +266,7 @@ func main() { [[Back to top]](#) ## list-segments -List Segments +List segments This API returns a list of all segments. A token with ORG_ADMIN or API authority is required to call this API. @@ -333,7 +333,7 @@ func main() { [[Back to top]](#) ## patch-segment -Update Segment +Update segment Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ServiceDeskIntegrationAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ServiceDeskIntegrationAPI.md index 61a3fe295..8814c97b8 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/ServiceDeskIntegrationAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ServiceDeskIntegrationAPI.md @@ -39,20 +39,20 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-service-desk-integration**](#create-service-desk-integration) | **Post** `/service-desk-integrations` | Create new Service Desk integration -[**delete-service-desk-integration**](#delete-service-desk-integration) | **Delete** `/service-desk-integrations/{id}` | Delete a Service Desk integration -[**get-service-desk-integration**](#get-service-desk-integration) | **Get** `/service-desk-integrations/{id}` | Get a Service Desk integration -[**get-service-desk-integration-list**](#get-service-desk-integration-list) | **Get** `/service-desk-integrations` | List existing Service Desk integrations -[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **Get** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName -[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **Get** `/service-desk-integrations/types` | List Service Desk integration types +[**create-service-desk-integration**](#create-service-desk-integration) | **Post** `/service-desk-integrations` | Create new service desk integration +[**delete-service-desk-integration**](#delete-service-desk-integration) | **Delete** `/service-desk-integrations/{id}` | Delete a service desk integration +[**get-service-desk-integration**](#get-service-desk-integration) | **Get** `/service-desk-integrations/{id}` | Get a service desk integration +[**get-service-desk-integration-list**](#get-service-desk-integration-list) | **Get** `/service-desk-integrations` | List existing service desk integrations +[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **Get** `/service-desk-integrations/templates/{scriptName}` | Service desk integration template by scriptname +[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **Get** `/service-desk-integrations/types` | List service desk integration types [**get-status-check-details**](#get-status-check-details) | **Get** `/service-desk-integrations/status-check-configuration` | Get the time check configuration -[**patch-service-desk-integration**](#patch-service-desk-integration) | **Patch** `/service-desk-integrations/{id}` | Patch a Service Desk Integration -[**put-service-desk-integration**](#put-service-desk-integration) | **Put** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**patch-service-desk-integration**](#patch-service-desk-integration) | **Patch** `/service-desk-integrations/{id}` | Patch a service desk integration +[**put-service-desk-integration**](#put-service-desk-integration) | **Put** `/service-desk-integrations/{id}` | Update a service desk integration [**update-status-check-details**](#update-status-check-details) | **Put** `/service-desk-integrations/status-check-configuration` | Update the time check configuration ## create-service-desk-integration -Create new Service Desk integration +Create new service desk integration Create a new Service Desk integration. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-service-desk-integration) @@ -149,7 +149,7 @@ func main() { [[Back to top]](#) ## delete-service-desk-integration -Delete a Service Desk integration +Delete a service desk integration Delete an existing Service Desk integration by ID. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-service-desk-integration) @@ -214,7 +214,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integration -Get a Service Desk integration +Get a service desk integration Get an existing Service Desk integration by ID. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration) @@ -280,7 +280,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integration-list -List existing Service Desk integrations +List existing service desk integrations Get a list of Service Desk integration objects. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-list) @@ -350,7 +350,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integration-template -Service Desk integration template by scriptName +Service desk integration template by scriptname This API endpoint returns an existing Service Desk integration template by scriptName. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-template) @@ -416,7 +416,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integration-types -List Service Desk integration types +List service desk integration types This API endpoint returns the current list of supported Service Desk integration types. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-types) @@ -530,7 +530,7 @@ func main() { [[Back to top]](#) ## patch-service-desk-integration -Patch a Service Desk Integration +Patch a service desk integration Update an existing Service Desk integration by ID with a PATCH request. [API Spec](https://developer.sailpoint.com/docs/api/beta/patch-service-desk-integration) @@ -603,7 +603,7 @@ func main() { [[Back to top]](#) ## put-service-desk-integration -Update a Service Desk integration +Update a service desk integration Update an existing Service Desk integration by ID. [API Spec](https://developer.sailpoint.com/docs/api/beta/put-service-desk-integration) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SourcesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SourcesAPI.md index 9fd6dda8e..2a817122f 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/SourcesAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SourcesAPI.md @@ -72,53 +72,53 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-provisioning-policy**](#create-provisioning-policy) | **Post** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy -[**create-source**](#create-source) | **Post** `/sources` | Creates a source in IdentityNow. -[**create-source-schema**](#create-source-schema) | **Post** `/sources/{sourceId}/schemas` | Create Schema on Source -[**delete**](#delete) | **Delete** `/sources/{id}` | Delete Source by ID -[**delete-accounts-async**](#delete-accounts-async) | **Post** `/sources/{sourceId}/remove-accounts` | Remove All Accounts in a Source -[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **Delete** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration -[**delete-provisioning-policy**](#delete-provisioning-policy) | **Delete** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType -[**delete-source-schema**](#delete-source-schema) | **Delete** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID -[**get-correlation-config**](#get-correlation-config) | **Get** `/sources/{sourceId}/correlation-config` | Get Source Correlation Configuration -[**get-native-change-detection-config**](#get-native-change-detection-config) | **Get** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration -[**get-provisioning-policy**](#get-provisioning-policy) | **Get** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType -[**get-source**](#get-source) | **Get** `/sources/{id}` | Get Source by ID +[**create-provisioning-policy**](#create-provisioning-policy) | **Post** `/sources/{sourceId}/provisioning-policies` | Create provisioning policy +[**create-source**](#create-source) | **Post** `/sources` | Creates a source in identitynow. +[**create-source-schema**](#create-source-schema) | **Post** `/sources/{sourceId}/schemas` | Create schema on source +[**delete**](#delete) | **Delete** `/sources/{id}` | Delete source by id +[**delete-accounts-async**](#delete-accounts-async) | **Post** `/sources/{sourceId}/remove-accounts` | Remove all accounts in a source +[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **Delete** `/sources/{sourceId}/native-change-detection-config` | Delete native change detection configuration +[**delete-provisioning-policy**](#delete-provisioning-policy) | **Delete** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype +[**delete-source-schema**](#delete-source-schema) | **Delete** `/sources/{sourceId}/schemas/{schemaId}` | Delete source schema by id +[**get-correlation-config**](#get-correlation-config) | **Get** `/sources/{sourceId}/correlation-config` | Get source correlation configuration +[**get-native-change-detection-config**](#get-native-change-detection-config) | **Get** `/sources/{sourceId}/native-change-detection-config` | Native change detection configuration +[**get-provisioning-policy**](#get-provisioning-policy) | **Get** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype +[**get-source**](#get-source) | **Get** `/sources/{id}` | Get source by id [**get-source-accounts-schema**](#get-source-accounts-schema) | **Get** `/sources/{sourceId}/schemas/accounts` | Downloads source accounts schema template -[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **Get** `/sources/{id}/attribute-sync-config` | Attribute Sync Config +[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **Get** `/sources/{id}/attribute-sync-config` | Attribute sync config [**get-source-config**](#get-source-config) | **Get** `/sources/{id}/connectors/source-config` | Gets source config with language translations -[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **Get** `/sources/{sourceId}/entitlement-request-config` | Get Source Entitlement Request Configuration +[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **Get** `/sources/{sourceId}/entitlement-request-config` | Get source entitlement request configuration [**get-source-entitlements-schema**](#get-source-entitlements-schema) | **Get** `/sources/{sourceId}/schemas/entitlements` | Downloads source entitlements schema template -[**get-source-schema**](#get-source-schema) | **Get** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID -[**get-source-schemas**](#get-source-schemas) | **Get** `/sources/{sourceId}/schemas` | List Schemas on Source -[**import-accounts**](#import-accounts) | **Post** `/sources/{sourceId}/load-accounts` | Account Aggregation -[**import-entitlements**](#import-entitlements) | **Post** `/sources/{sourceId}/load-entitlements` | Entitlement Aggregation +[**get-source-schema**](#get-source-schema) | **Get** `/sources/{sourceId}/schemas/{schemaId}` | Get source schema by id +[**get-source-schemas**](#get-source-schemas) | **Get** `/sources/{sourceId}/schemas` | List schemas on source +[**import-accounts**](#import-accounts) | **Post** `/sources/{sourceId}/load-accounts` | Account aggregation +[**import-entitlements**](#import-entitlements) | **Post** `/sources/{sourceId}/load-entitlements` | Entitlement aggregation [**import-source-accounts-schema**](#import-source-accounts-schema) | **Post** `/sources/{sourceId}/schemas/accounts` | Uploads source accounts schema template [**import-source-connector-file**](#import-source-connector-file) | **Post** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source [**import-source-entitlements-schema**](#import-source-entitlements-schema) | **Post** `/sources/{sourceId}/schemas/entitlements` | Uploads source entitlements schema template -[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **Post** `/sources/{sourceId}/load-uncorrelated-accounts` | Process Uncorrelated Accounts -[**list-provisioning-policies**](#list-provisioning-policies) | **Get** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies -[**list-sources**](#list-sources) | **Get** `/sources` | Lists all sources in IdentityNow. +[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **Post** `/sources/{sourceId}/load-uncorrelated-accounts` | Process uncorrelated accounts +[**list-provisioning-policies**](#list-provisioning-policies) | **Get** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies +[**list-sources**](#list-sources) | **Get** `/sources` | Lists all sources in identitynow. [**peek-resource-objects**](#peek-resource-objects) | **Post** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects [**ping-cluster**](#ping-cluster) | **Post** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector -[**put-correlation-config**](#put-correlation-config) | **Put** `/sources/{sourceId}/correlation-config` | Update Source Correlation Configuration -[**put-native-change-detection-config**](#put-native-change-detection-config) | **Put** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration -[**put-provisioning-policy**](#put-provisioning-policy) | **Put** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType -[**put-source**](#put-source) | **Put** `/sources/{id}` | Update Source (Full) -[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **Put** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config -[**put-source-schema**](#put-source-schema) | **Put** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**put-correlation-config**](#put-correlation-config) | **Put** `/sources/{sourceId}/correlation-config` | Update source correlation configuration +[**put-native-change-detection-config**](#put-native-change-detection-config) | **Put** `/sources/{sourceId}/native-change-detection-config` | Update native change detection configuration +[**put-provisioning-policy**](#put-provisioning-policy) | **Put** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype +[**put-source**](#put-source) | **Put** `/sources/{id}` | Update source (full) +[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **Put** `/sources/{id}/attribute-sync-config` | Update attribute sync config +[**put-source-schema**](#put-source-schema) | **Put** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (full) [**sync-attributes-for-source**](#sync-attributes-for-source) | **Post** `/sources/{sourceId}/synchronize-attributes` | Synchronize single source attributes. [**test-source-configuration**](#test-source-configuration) | **Post** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector [**test-source-connection**](#test-source-connection) | **Post** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector. -[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **Post** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies -[**update-provisioning-policy**](#update-provisioning-policy) | **Patch** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy -[**update-source**](#update-source) | **Patch** `/sources/{id}` | Update Source (Partial) -[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **Put** `/sources/{sourceId}/entitlement-request-config` | Update Source Entitlement Request Configuration -[**update-source-schema**](#update-source-schema) | **Patch** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) +[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **Post** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies +[**update-provisioning-policy**](#update-provisioning-policy) | **Patch** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy +[**update-source**](#update-source) | **Patch** `/sources/{id}` | Update source (partial) +[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **Put** `/sources/{sourceId}/entitlement-request-config` | Update source entitlement request configuration +[**update-source-schema**](#update-source-schema) | **Patch** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (partial) ## create-provisioning-policy -Create Provisioning Policy +Create provisioning policy This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. @@ -232,7 +232,7 @@ func main() { [[Back to top]](#) ## create-source -Creates a source in IdentityNow. +Creates a source in identitynow. This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. @@ -384,7 +384,7 @@ func main() { [[Back to top]](#) ## create-source-schema -Create Schema on Source +Create schema on source Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/beta/create-source-schema) @@ -490,7 +490,7 @@ func main() { [[Back to top]](#) ## delete -Delete Source by ID +Delete source by id Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. @@ -558,7 +558,7 @@ func main() { [[Back to top]](#) ## delete-accounts-async -Remove All Accounts in a Source +Remove all accounts in a source Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: @@ -630,7 +630,7 @@ func main() { [[Back to top]](#) ## delete-native-change-detection-config -Delete Native Change Detection Configuration +Delete native change detection configuration Deletes the native change detection configuration for the source specified by the given ID. A token with API, or ORG_ADMIN authority is required to call this API. @@ -696,7 +696,7 @@ func main() { [[Back to top]](#) ## delete-provisioning-policy -Delete Provisioning Policy by UsageType +Delete provisioning policy by usagetype Deletes the provisioning policy with the specified usage on an application. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-provisioning-policy) @@ -764,7 +764,7 @@ func main() { [[Back to top]](#) ## delete-source-schema -Delete Source Schema by ID +Delete source schema by id [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-source-schema) @@ -832,7 +832,7 @@ func main() { [[Back to top]](#) ## get-correlation-config -Get Source Correlation Configuration +Get source correlation configuration This API returns the existing correlation configuration for a source specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-correlation-config) @@ -898,7 +898,7 @@ func main() { [[Back to top]](#) ## get-native-change-detection-config -Native Change Detection Configuration +Native change detection configuration This API returns the existing native change detection configuration for a source specified by the given ID. A token with ORG_ADMIN authority is required to call this API. @@ -965,7 +965,7 @@ func main() { [[Back to top]](#) ## get-provisioning-policy -Get Provisioning Policy by UsageType +Get provisioning policy by usagetype This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-provisioning-policy) @@ -1034,7 +1034,7 @@ func main() { [[Back to top]](#) ## get-source -Get Source by ID +Get source by id Use this API to get a source by a specified ID in Identity Security Cloud (ISC). A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. @@ -1166,7 +1166,7 @@ func main() { [[Back to top]](#) ## get-source-attr-sync-config -Attribute Sync Config +Attribute sync config This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. A token with ORG_ADMIN or HELPDESK authority is required to call this API. @@ -1302,7 +1302,7 @@ func main() { [[Back to top]](#) ## get-source-entitlement-request-config -Get Source Entitlement Request Configuration +Get source entitlement request configuration This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. @@ -1441,7 +1441,7 @@ func main() { [[Back to top]](#) ## get-source-schema -Get Source Schema by ID +Get source schema by id Get the Source Schema by ID in IdentityNow. @@ -1511,7 +1511,7 @@ func main() { [[Back to top]](#) ## get-source-schemas -List Schemas on Source +List schemas on source Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-schemas) @@ -1581,7 +1581,7 @@ func main() { [[Back to top]](#) ## import-accounts -Account Aggregation +Account aggregation Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. @@ -1654,7 +1654,7 @@ func main() { [[Back to top]](#) ## import-entitlements -Entitlement Aggregation +Entitlement aggregation Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. @@ -1932,7 +1932,7 @@ func main() { [[Back to top]](#) ## import-uncorrelated-accounts -Process Uncorrelated Accounts +Process uncorrelated accounts File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` [API Spec](https://developer.sailpoint.com/docs/api/beta/import-uncorrelated-accounts) @@ -2000,7 +2000,7 @@ func main() { [[Back to top]](#) ## list-provisioning-policies -Lists ProvisioningPolicies +Lists provisioningpolicies This end-point lists all the ProvisioningPolicies in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-provisioning-policies) @@ -2066,7 +2066,7 @@ func main() { [[Back to top]](#) ## list-sources -Lists all sources in IdentityNow. +Lists all sources in identitynow. This end-point lists all the sources in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. @@ -2286,7 +2286,7 @@ func main() { [[Back to top]](#) ## put-correlation-config -Update Source Correlation Configuration +Update source correlation configuration Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. [API Spec](https://developer.sailpoint.com/docs/api/beta/put-correlation-config) @@ -2379,7 +2379,7 @@ func main() { [[Back to top]](#) ## put-native-change-detection-config -Update Native Change Detection Configuration +Update native change detection configuration Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. A token with ORG_ADMIN authority is required to call this API. @@ -2461,7 +2461,7 @@ func main() { [[Back to top]](#) ## put-provisioning-policy -Update Provisioning Policy by UsageType +Update provisioning policy by usagetype This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. @@ -2578,7 +2578,7 @@ func main() { [[Back to top]](#) ## put-source -Update Source (Full) +Update source (full) Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: @@ -2747,7 +2747,7 @@ func main() { [[Back to top]](#) ## put-source-attr-sync-config -Update Attribute Sync Config +Update attribute sync config Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. A token with ORG_ADMIN authority is required to call this API. @@ -2839,7 +2839,7 @@ func main() { [[Back to top]](#) ## put-source-schema -Update Source Schema (Full) +Update source schema (full) This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name @@ -3154,7 +3154,7 @@ func main() { [[Back to top]](#) ## update-provisioning-policies-in-bulk -Bulk Update Provisioning Policies +Bulk update provisioning policies This end-point updates a list of provisioning policies on the specified source in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/beta/update-provisioning-policies-in-bulk) @@ -3227,7 +3227,7 @@ func main() { [[Back to top]](#) ## update-provisioning-policy -Partial update of Provisioning Policy +Partial update of provisioning policy This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. @@ -3305,7 +3305,7 @@ func main() { [[Back to top]](#) ## update-source -Update Source (Partial) +Update source (partial) Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. @@ -3394,7 +3394,7 @@ func main() { [[Back to top]](#) ## update-source-entitlement-request-config -Update Source Entitlement Request Configuration +Update source entitlement request configuration This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. @@ -3495,7 +3495,7 @@ func main() { [[Back to top]](#) ## update-source-schema -Update Source Schema (Partial) +Update source schema (partial) Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SuggestedEntitlementDescriptionAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SuggestedEntitlementDescriptionAPI.md index 9bff353a9..fcd14db0d 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/SuggestedEntitlementDescriptionAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SuggestedEntitlementDescriptionAPI.md @@ -18,17 +18,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-sed-batch-stats**](#get-sed-batch-stats) | **Get** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request -[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List Sed Batch Request -[**list-seds**](#list-seds) | **Get** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions -[**patch-sed**](#patch-sed) | **Patch** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description -[**submit-sed-approval**](#submit-sed-approval) | **Post** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request -[**submit-sed-assignment**](#submit-sed-assignment) | **Post** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request -[**submit-sed-batch-request**](#submit-sed-batch-request) | **Post** `/suggested-entitlement-description-batches` | Submit Sed Batch Request +[**get-sed-batch-stats**](#get-sed-batch-stats) | **Get** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit sed batch stats request +[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List sed batch request +[**list-seds**](#list-seds) | **Get** `/suggested-entitlement-descriptions` | List suggested entitlement descriptions +[**patch-sed**](#patch-sed) | **Patch** `/suggested-entitlement-descriptions` | Patch suggested entitlement description +[**submit-sed-approval**](#submit-sed-approval) | **Post** `/suggested-entitlement-description-approvals` | Submit bulk approval request +[**submit-sed-assignment**](#submit-sed-assignment) | **Post** `/suggested-entitlement-description-assignments` | Submit sed assignment request +[**submit-sed-batch-request**](#submit-sed-batch-request) | **Post** `/suggested-entitlement-description-batches` | Submit sed batch request ## get-sed-batch-stats -Submit Sed Batch Stats Request +Submit sed batch stats request Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. @@ -98,7 +98,7 @@ func main() { [[Back to top]](#) ## get-sed-batches -List Sed Batch Request +List sed batch request List Sed Batches. API responses with Sed Batch Status @@ -156,7 +156,7 @@ func main() { [[Back to top]](#) ## list-seds -List Suggested Entitlement Descriptions +List suggested entitlement descriptions List of Suggested Entitlement Descriptions (SED) SED field descriptions: @@ -244,7 +244,7 @@ func main() { [[Back to top]](#) ## patch-sed -Patch Suggested Entitlement Description +Patch suggested entitlement description Patch Suggested Entitlement Description [API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sed) @@ -317,7 +317,7 @@ func main() { [[Back to top]](#) ## submit-sed-approval -Submit Bulk Approval Request +Submit bulk approval request Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status @@ -385,7 +385,7 @@ func main() { [[Back to top]](#) ## submit-sed-assignment -Submit Sed Assignment Request +Submit sed assignment request Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together @@ -459,7 +459,7 @@ func main() { [[Back to top]](#) ## submit-sed-batch-request -Submit Sed Batch Request +Submit sed batch request Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/TaggedObjectsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/TaggedObjectsAPI.md index 399917524..10e69c816 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/TaggedObjectsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/TaggedObjectsAPI.md @@ -68,18 +68,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**delete-tagged-object**](#delete-tagged-object) | **Delete** `/tagged-objects/{type}/{id}` | Delete Object Tags -[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **Post** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects -[**get-tagged-object**](#get-tagged-object) | **Get** `/tagged-objects/{type}/{id}` | Get Tagged Object -[**list-tagged-objects**](#list-tagged-objects) | **Get** `/tagged-objects` | List Tagged Objects -[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **Get** `/tagged-objects/{type}` | List Tagged Objects by Type -[**put-tagged-object**](#put-tagged-object) | **Put** `/tagged-objects/{type}/{id}` | Update Tagged Object -[**set-tag-to-object**](#set-tag-to-object) | **Post** `/tagged-objects` | Add Tag to Object -[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **Post** `/tagged-objects/bulk-add` | Tag Multiple Objects +[**delete-tagged-object**](#delete-tagged-object) | **Delete** `/tagged-objects/{type}/{id}` | Delete object tags +[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **Post** `/tagged-objects/bulk-remove` | Remove tags from multiple objects +[**get-tagged-object**](#get-tagged-object) | **Get** `/tagged-objects/{type}/{id}` | Get tagged object +[**list-tagged-objects**](#list-tagged-objects) | **Get** `/tagged-objects` | List tagged objects +[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **Get** `/tagged-objects/{type}` | List tagged objects by type +[**put-tagged-object**](#put-tagged-object) | **Put** `/tagged-objects/{type}/{id}` | Update tagged object +[**set-tag-to-object**](#set-tag-to-object) | **Post** `/tagged-objects` | Add tag to object +[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **Post** `/tagged-objects/bulk-add` | Tag multiple objects ## delete-tagged-object -Delete Object Tags +Delete object tags Delete all tags from a tagged object. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-tagged-object) @@ -147,7 +147,7 @@ func main() { [[Back to top]](#) ## delete-tags-to-many-object -Remove Tags from Multiple Objects +Remove tags from multiple objects This API removes tags from multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. @@ -227,7 +227,7 @@ func main() { [[Back to top]](#) ## get-tagged-object -Get Tagged Object +Get tagged object This gets a tagged object for the specified type. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-tagged-object) @@ -296,7 +296,7 @@ func main() { [[Back to top]](#) ## list-tagged-objects -List Tagged Objects +List tagged objects This API returns a list of all tagged objects. Any authenticated token may be used to call this API. @@ -366,7 +366,7 @@ func main() { [[Back to top]](#) ## list-tagged-objects-by-type -List Tagged Objects by Type +List tagged objects by type This API returns a list of all tagged objects by type. Any authenticated token may be used to call this API. @@ -442,7 +442,7 @@ func main() { [[Back to top]](#) ## put-tagged-object -Update Tagged Object +Update tagged object This updates a tagged object for the specified type. [API Spec](https://developer.sailpoint.com/docs/api/beta/put-tagged-object) @@ -525,7 +525,7 @@ func main() { [[Back to top]](#) ## set-tag-to-object -Add Tag to Object +Add tag to object This adds a tag to an object. Any authenticated token may be used to call this API. @@ -600,7 +600,7 @@ func main() { [[Back to top]](#) ## set-tags-to-many-objects -Tag Multiple Objects +Tag multiple objects This API adds tags to multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/TagsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/TagsAPI.md index b3faad2be..6216e2bf5 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/TagsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/TagsAPI.md @@ -15,14 +15,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-tag**](#create-tag) | **Post** `/tags` | Create Tag -[**delete-tag-by-id**](#delete-tag-by-id) | **Delete** `/tags/{id}` | Delete Tag -[**get-tag-by-id**](#get-tag-by-id) | **Get** `/tags/{id}` | Get Tag By Id -[**list-tags**](#list-tags) | **Get** `/tags` | List Tags +[**create-tag**](#create-tag) | **Post** `/tags` | Create tag +[**delete-tag-by-id**](#delete-tag-by-id) | **Delete** `/tags/{id}` | Delete tag +[**get-tag-by-id**](#get-tag-by-id) | **Get** `/tags/{id}` | Get tag by id +[**list-tags**](#list-tags) | **Get** `/tags` | List tags ## create-tag -Create Tag +Create tag This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. @@ -106,7 +106,7 @@ func main() { [[Back to top]](#) ## delete-tag-by-id -Delete Tag +Delete tag This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. @@ -173,7 +173,7 @@ func main() { [[Back to top]](#) ## get-tag-by-id -Get Tag By Id +Get tag by id Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. @@ -241,7 +241,7 @@ func main() { [[Back to top]](#) ## list-tags -List Tags +List tags This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/TaskManagementAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/TaskManagementAPI.md index f536882b2..a9494397e 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/TaskManagementAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/TaskManagementAPI.md @@ -15,15 +15,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-pending-task-headers**](#get-pending-task-headers) | **Head** `/task-status/pending-tasks` | Retrieve Pending Task List Headers -[**get-pending-tasks**](#get-pending-tasks) | **Get** `/task-status/pending-tasks` | Retrieve Pending Task Status List -[**get-task-status**](#get-task-status) | **Get** `/task-status/{id}` | Get Task Status by ID -[**get-task-status-list**](#get-task-status-list) | **Get** `/task-status` | Retrieve Task Status List -[**update-task-status**](#update-task-status) | **Patch** `/task-status/{id}` | Update Task Status by ID +[**get-pending-task-headers**](#get-pending-task-headers) | **Head** `/task-status/pending-tasks` | Retrieve pending task list headers +[**get-pending-tasks**](#get-pending-tasks) | **Get** `/task-status/pending-tasks` | Retrieve pending task status list +[**get-task-status**](#get-task-status) | **Get** `/task-status/{id}` | Get task status by id +[**get-task-status-list**](#get-task-status-list) | **Get** `/task-status` | Retrieve task status list +[**update-task-status**](#update-task-status) | **Patch** `/task-status/{id}` | Update task status by id ## get-pending-task-headers -Retrieve Pending Task List Headers +Retrieve pending task list headers Responds with headers only for list of task statuses for pending tasks. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-pending-task-headers) @@ -88,7 +88,7 @@ func main() { [[Back to top]](#) ## get-pending-tasks -Retrieve Pending Task Status List +Retrieve pending task status list Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) @@ -154,7 +154,7 @@ func main() { [[Back to top]](#) ## get-task-status -Get Task Status by ID +Get task status by id Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-task-status) @@ -220,7 +220,7 @@ func main() { [[Back to top]](#) ## get-task-status-list -Retrieve Task Status List +Retrieve task status list Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint. @@ -291,7 +291,7 @@ func main() { [[Back to top]](#) ## update-task-status -Update Task Status by ID +Update task status by id Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. [API Spec](https://developer.sailpoint.com/docs/api/beta/update-task-status) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/TenantAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/TenantAPI.md index 482565abd..c87ae5468 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/TenantAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/TenantAPI.md @@ -15,11 +15,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-tenant**](#get-tenant) | **Get** `/tenant` | Get Tenant Information. +[**get-tenant**](#get-tenant) | **Get** `/tenant` | Get tenant information. ## get-tenant -Get Tenant Information. +Get tenant information. This rest endpoint can be used to retrieve tenant details. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/TransformsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/TransformsAPI.md index 998faf0af..74bc65f89 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/TransformsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/TransformsAPI.md @@ -22,7 +22,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create-transform**](#create-transform) | **Post** `/transforms` | Create transform [**delete-transform**](#delete-transform) | **Delete** `/transforms/{id}` | Delete a transform -[**get-transform**](#get-transform) | **Get** `/transforms/{id}` | Transform by ID +[**get-transform**](#get-transform) | **Get** `/transforms/{id}` | Transform by id [**list-transforms**](#list-transforms) | **Get** `/transforms` | List transforms [**update-transform**](#update-transform) | **Put** `/transforms/{id}` | Update a transform @@ -165,7 +165,7 @@ func main() { [[Back to top]](#) ## get-transform -Transform by ID +Transform by id This API returns the transform specified by the given ID. A token with transform read authority is required to call this API. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/TriggersAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/TriggersAPI.md index 53f42d6d0..d9e00c106 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/TriggersAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/TriggersAPI.md @@ -56,20 +56,20 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**complete-trigger-invocation**](#complete-trigger-invocation) | **Post** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation -[**create-subscription**](#create-subscription) | **Post** `/trigger-subscriptions` | Create a Subscription -[**delete-subscription**](#delete-subscription) | **Delete** `/trigger-subscriptions/{id}` | Delete a Subscription -[**list-subscriptions**](#list-subscriptions) | **Get** `/trigger-subscriptions` | List Subscriptions -[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **Get** `/trigger-invocations/status` | List Latest Invocation Statuses -[**list-triggers**](#list-triggers) | **Get** `/triggers` | List Triggers -[**patch-subscription**](#patch-subscription) | **Patch** `/trigger-subscriptions/{id}` | Patch a Subscription -[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **Post** `/trigger-invocations/test` | Start a Test Invocation -[**test-subscription-filter**](#test-subscription-filter) | **Post** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter -[**update-subscription**](#update-subscription) | **Put** `/trigger-subscriptions/{id}` | Update a Subscription +[**complete-trigger-invocation**](#complete-trigger-invocation) | **Post** `/trigger-invocations/{id}/complete` | Complete trigger invocation +[**create-subscription**](#create-subscription) | **Post** `/trigger-subscriptions` | Create a subscription +[**delete-subscription**](#delete-subscription) | **Delete** `/trigger-subscriptions/{id}` | Delete a subscription +[**list-subscriptions**](#list-subscriptions) | **Get** `/trigger-subscriptions` | List subscriptions +[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **Get** `/trigger-invocations/status` | List latest invocation statuses +[**list-triggers**](#list-triggers) | **Get** `/triggers` | List triggers +[**patch-subscription**](#patch-subscription) | **Patch** `/trigger-subscriptions/{id}` | Patch a subscription +[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **Post** `/trigger-invocations/test` | Start a test invocation +[**test-subscription-filter**](#test-subscription-filter) | **Post** `/trigger-subscriptions/validate-filter` | Validate a subscription filter +[**update-subscription**](#update-subscription) | **Put** `/trigger-subscriptions/{id}` | Update a subscription ## complete-trigger-invocation -Complete Trigger Invocation +Complete trigger invocation Completes an invocation to a REQUEST_RESPONSE type trigger. [API Spec](https://developer.sailpoint.com/docs/api/beta/complete-trigger-invocation) @@ -147,7 +147,7 @@ func main() { [[Back to top]](#) ## create-subscription -Create a Subscription +Create a subscription This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig @@ -240,7 +240,7 @@ func main() { [[Back to top]](#) ## delete-subscription -Delete a Subscription +Delete a subscription Deletes an existing subscription to a trigger. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-subscription) @@ -305,7 +305,7 @@ func main() { [[Back to top]](#) ## list-subscriptions -List Subscriptions +List subscriptions Gets a list of all trigger subscriptions. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-subscriptions) @@ -375,7 +375,7 @@ func main() { [[Back to top]](#) ## list-trigger-invocation-status -List Latest Invocation Statuses +List latest invocation statuses Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. @@ -447,7 +447,7 @@ func main() { [[Back to top]](#) ## list-triggers -List Triggers +List triggers Gets a list of triggers that are available in the tenant. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-triggers) @@ -517,7 +517,7 @@ func main() { [[Back to top]](#) ## patch-subscription -Patch a Subscription +Patch a subscription This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** @@ -592,7 +592,7 @@ func main() { [[Back to top]](#) ## start-test-trigger-invocation -Start a Test Invocation +Start a test invocation Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. [API Spec](https://developer.sailpoint.com/docs/api/beta/start-test-trigger-invocation) @@ -668,7 +668,7 @@ func main() { [[Back to top]](#) ## test-subscription-filter -Validate a Subscription Filter +Validate a subscription filter Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: @@ -741,7 +741,7 @@ func main() { [[Back to top]](#) ## update-subscription -Update a Subscription +Update a subscription This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/UIMetadataAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/UIMetadataAPI.md index 695d4a166..531d6dad2 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/UIMetadataAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/UIMetadataAPI.md @@ -16,12 +16,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-tenant-ui-metadata**](#get-tenant-ui-metadata) | **Get** `/ui-metadata/tenant` | Get a tenant UI metadata -[**set-tenant-ui-metadata**](#set-tenant-ui-metadata) | **Put** `/ui-metadata/tenant` | Update tenant UI metadata +[**get-tenant-ui-metadata**](#get-tenant-ui-metadata) | **Get** `/ui-metadata/tenant` | Get a tenant ui metadata +[**set-tenant-ui-metadata**](#set-tenant-ui-metadata) | **Put** `/ui-metadata/tenant` | Update tenant ui metadata ## get-tenant-ui-metadata -Get a tenant UI metadata +Get a tenant ui metadata This API endpoint retrieves UI metadata configured for your tenant. A token with ORG_ADMIN authority is required to call this API. @@ -79,7 +79,7 @@ func main() { [[Back to top]](#) ## set-tenant-ui-metadata -Update tenant UI metadata +Update tenant ui metadata This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. A token with ORG_ADMIN authority is required to call this API. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/VendorConnectorMappingsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/VendorConnectorMappingsAPI.md index 9aab4da76..66d6801d5 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/VendorConnectorMappingsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/VendorConnectorMappingsAPI.md @@ -19,13 +19,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **Post** `/vendor-connector-mappings` | Create Vendor Connector Mapping -[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **Delete** `/vendor-connector-mappings` | Delete Vendor Connector Mapping -[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **Get** `/vendor-connector-mappings` | List Vendor Connector Mappings +[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **Post** `/vendor-connector-mappings` | Create vendor connector mapping +[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **Delete** `/vendor-connector-mappings` | Delete vendor connector mapping +[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **Get** `/vendor-connector-mappings` | List vendor connector mappings ## create-vendor-connector-mapping -Create Vendor Connector Mapping +Create vendor connector mapping Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. @@ -115,7 +115,7 @@ func main() { [[Back to top]](#) ## delete-vendor-connector-mapping -Delete Vendor Connector Mapping +Delete vendor connector mapping Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. @@ -205,7 +205,7 @@ func main() { [[Back to top]](#) ## get-vendor-connector-mappings -List Vendor Connector Mappings +List vendor connector mappings Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/WorkItemsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/WorkItemsAPI.md index 1b4637ed2..83f848197 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/WorkItemsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/WorkItemsAPI.md @@ -29,26 +29,26 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-approval-item**](#approve-approval-item) | **Post** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item -[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **Post** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items -[**complete-work-item**](#complete-work-item) | **Post** `/work-items/{id}` | Complete a Work Item -[**get-completed-work-items**](#get-completed-work-items) | **Get** `/work-items/completed` | Completed Work Items -[**get-count-completed-work-items**](#get-count-completed-work-items) | **Get** `/work-items/completed/count` | Count Completed Work Items -[**get-count-work-items**](#get-count-work-items) | **Get** `/work-items/count` | Count Work Items -[**get-work-item**](#get-work-item) | **Get** `/work-items/{id}` | Get a Work Item -[**get-work-items-summary**](#get-work-items-summary) | **Get** `/work-items/summary` | Work Items Summary -[**list-work-items**](#list-work-items) | **Get** `/work-items` | List Work Items -[**reject-approval-item**](#reject-approval-item) | **Post** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item -[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **Post** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items -[**submit-account-selection**](#submit-account-selection) | **Post** `/work-items/{id}/submit-account-selection` | Submit Account Selections -[**submit-forward-work-item**](#submit-forward-work-item) | **Post** `/work-items/{id}/forward` | Forward a Work Item +[**approve-approval-item**](#approve-approval-item) | **Post** `/work-items/{id}/approve/{approvalItemId}` | Approve an approval item +[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **Post** `/work-items/bulk-approve/{id}` | Bulk approve approval items +[**complete-work-item**](#complete-work-item) | **Post** `/work-items/{id}` | Complete a work item +[**get-completed-work-items**](#get-completed-work-items) | **Get** `/work-items/completed` | Completed work items +[**get-count-completed-work-items**](#get-count-completed-work-items) | **Get** `/work-items/completed/count` | Count completed work items +[**get-count-work-items**](#get-count-work-items) | **Get** `/work-items/count` | Count work items +[**get-work-item**](#get-work-item) | **Get** `/work-items/{id}` | Get a work item +[**get-work-items-summary**](#get-work-items-summary) | **Get** `/work-items/summary` | Work items summary +[**list-work-items**](#list-work-items) | **Get** `/work-items` | List work items +[**reject-approval-item**](#reject-approval-item) | **Post** `/work-items/{id}/reject/{approvalItemId}` | Reject an approval item +[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **Post** `/work-items/bulk-reject/{id}` | Bulk reject approval items +[**submit-account-selection**](#submit-account-selection) | **Post** `/work-items/{id}/submit-account-selection` | Submit account selections +[**submit-forward-work-item**](#submit-forward-work-item) | **Post** `/work-items/{id}/forward` | Forward a work item ## approve-approval-item :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Approve an Approval Item +Approve an approval item This API approves an Approval Item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/beta/approve-approval-item) @@ -120,7 +120,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Bulk approve Approval Items +Bulk approve approval items This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/beta/approve-approval-items-in-bulk) @@ -189,7 +189,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Complete a Work Item +Complete a work item This API completes a work item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/beta/complete-work-item) @@ -260,7 +260,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Completed Work Items +Completed work items This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-completed-work-items) @@ -331,7 +331,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Count Completed Work Items +Count completed work items This gets a count of completed work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-count-completed-work-items) @@ -400,7 +400,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Count Work Items +Count work items This gets a count of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-count-work-items) @@ -465,7 +465,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Get a Work Item +Get a work item This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-work-item) @@ -536,7 +536,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Work Items Summary +Work items summary This gets a summary of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-work-items-summary) @@ -601,7 +601,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -List Work Items +List work items This gets a collection of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-work-items) @@ -672,7 +672,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Reject an Approval Item +Reject an approval item This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/beta/reject-approval-item) @@ -744,7 +744,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Bulk reject Approval Items +Bulk reject approval items This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/beta/reject-approval-items-in-bulk) @@ -813,7 +813,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Submit Account Selections +Submit account selections This API submits account selections. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/beta/submit-account-selection) @@ -889,7 +889,7 @@ func main() { :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: -Forward a Work Item +Forward a work item This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/beta/submit-forward-work-item) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/WorkReassignmentAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/WorkReassignmentAPI.md index 93db8c51e..0b30521e3 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/WorkReassignmentAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/WorkReassignmentAPI.md @@ -25,19 +25,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-reassignment-configuration**](#create-reassignment-configuration) | **Post** `/reassignment-configurations` | Create a Reassignment Configuration -[**delete-reassignment-configuration**](#delete-reassignment-configuration) | **Delete** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration -[**get-evaluate-reassignment-configuration**](#get-evaluate-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration -[**get-reassignment-config-types**](#get-reassignment-config-types) | **Get** `/reassignment-configurations/types` | List Reassignment Config Types -[**get-reassignment-configuration**](#get-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration -[**get-tenant-config-configuration**](#get-tenant-config-configuration) | **Get** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings -[**list-reassignment-configurations**](#list-reassignment-configurations) | **Get** `/reassignment-configurations` | List Reassignment Configurations -[**put-reassignment-config**](#put-reassignment-config) | **Put** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration -[**put-tenant-configuration**](#put-tenant-configuration) | **Put** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings +[**create-reassignment-configuration**](#create-reassignment-configuration) | **Post** `/reassignment-configurations` | Create a reassignment configuration +[**delete-reassignment-configuration**](#delete-reassignment-configuration) | **Delete** `/reassignment-configurations/{identityId}/{configType}` | Delete reassignment configuration +[**get-evaluate-reassignment-configuration**](#get-evaluate-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate reassignment configuration +[**get-reassignment-config-types**](#get-reassignment-config-types) | **Get** `/reassignment-configurations/types` | List reassignment config types +[**get-reassignment-configuration**](#get-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}` | Get reassignment configuration +[**get-tenant-config-configuration**](#get-tenant-config-configuration) | **Get** `/reassignment-configurations/tenant-config` | Get tenant-wide reassignment configuration settings +[**list-reassignment-configurations**](#list-reassignment-configurations) | **Get** `/reassignment-configurations` | List reassignment configurations +[**put-reassignment-config**](#put-reassignment-config) | **Put** `/reassignment-configurations/{identityId}` | Update reassignment configuration +[**put-tenant-configuration**](#put-tenant-configuration) | **Put** `/reassignment-configurations/tenant-config` | Update tenant-wide reassignment configuration settings ## create-reassignment-configuration -Create a Reassignment Configuration +Create a reassignment configuration Creates a new Reassignment Configuration for the specified identity. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-reassignment-configuration) @@ -110,7 +110,7 @@ func main() { [[Back to top]](#) ## delete-reassignment-configuration -Delete Reassignment Configuration +Delete reassignment configuration Deletes a single reassignment configuration for the specified identity [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-reassignment-configuration) @@ -178,7 +178,7 @@ func main() { [[Back to top]](#) ## get-evaluate-reassignment-configuration -Evaluate Reassignment Configuration +Evaluate reassignment configuration Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-evaluate-reassignment-configuration) @@ -249,7 +249,7 @@ func main() { [[Back to top]](#) ## get-reassignment-config-types -List Reassignment Config Types +List reassignment config types Gets a collection of types which are available in the Reassignment Configuration UI. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-reassignment-config-types) @@ -306,7 +306,7 @@ func main() { [[Back to top]](#) ## get-reassignment-configuration -Get Reassignment Configuration +Get reassignment configuration Gets the Reassignment Configuration for an identity. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-reassignment-configuration) @@ -372,7 +372,7 @@ func main() { [[Back to top]](#) ## get-tenant-config-configuration -Get Tenant-wide Reassignment Configuration settings +Get tenant-wide reassignment configuration settings Gets the global Reassignment Configuration settings for the requestor's tenant. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant-config-configuration) @@ -429,7 +429,7 @@ func main() { [[Back to top]](#) ## list-reassignment-configurations -List Reassignment Configurations +List reassignment configurations Gets all Reassignment configuration for the current org. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-reassignment-configurations) @@ -493,7 +493,7 @@ func main() { [[Back to top]](#) ## put-reassignment-config -Update Reassignment Configuration +Update reassignment configuration Replaces existing Reassignment configuration for an identity with the newly provided configuration. [API Spec](https://developer.sailpoint.com/docs/api/beta/put-reassignment-config) @@ -572,7 +572,7 @@ func main() { [[Back to top]](#) ## put-tenant-configuration -Update Tenant-wide Reassignment Configuration settings +Update tenant-wide reassignment configuration settings Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. [API Spec](https://developer.sailpoint.com/docs/api/beta/put-tenant-configuration) diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/WorkflowsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/WorkflowsAPI.md index 970980c88..7961db1a2 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/WorkflowsAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/WorkflowsAPI.md @@ -16,28 +16,28 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**cancel-workflow-execution**](#cancel-workflow-execution) | **Post** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID -[**create-workflow**](#create-workflow) | **Post** `/workflows` | Create Workflow -[**delete-workflow**](#delete-workflow) | **Delete** `/workflows/{id}` | Delete Workflow By Id -[**get-workflow**](#get-workflow) | **Get** `/workflows/{id}` | Get Workflow By Id -[**get-workflow-execution**](#get-workflow-execution) | **Get** `/workflow-executions/{id}` | Get Workflow Execution -[**get-workflow-execution-history**](#get-workflow-execution-history) | **Get** `/workflow-executions/{id}/history` | Get Workflow Execution History -[**get-workflow-executions**](#get-workflow-executions) | **Get** `/workflows/{id}/executions` | List Workflow Executions -[**list-complete-workflow-library**](#list-complete-workflow-library) | **Get** `/workflow-library` | List Complete Workflow Library -[**list-workflow-library-actions**](#list-workflow-library-actions) | **Get** `/workflow-library/actions` | List Workflow Library Actions -[**list-workflow-library-operators**](#list-workflow-library-operators) | **Get** `/workflow-library/operators` | List Workflow Library Operators -[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **Get** `/workflow-library/triggers` | List Workflow Library Triggers -[**list-workflows**](#list-workflows) | **Get** `/workflows` | List Workflows -[**patch-workflow**](#patch-workflow) | **Patch** `/workflows/{id}` | Patch Workflow -[**post-external-execute-workflow**](#post-external-execute-workflow) | **Post** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger -[**post-workflow-external-trigger**](#post-workflow-external-trigger) | **Post** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client -[**put-workflow**](#put-workflow) | **Put** `/workflows/{id}` | Update Workflow -[**test-external-execute-workflow**](#test-external-execute-workflow) | **Post** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger -[**test-workflow**](#test-workflow) | **Post** `/workflows/{id}/test` | Test Workflow By Id +[**cancel-workflow-execution**](#cancel-workflow-execution) | **Post** `/workflow-executions/{id}/cancel` | Cancel workflow execution by id +[**create-workflow**](#create-workflow) | **Post** `/workflows` | Create workflow +[**delete-workflow**](#delete-workflow) | **Delete** `/workflows/{id}` | Delete workflow by id +[**get-workflow**](#get-workflow) | **Get** `/workflows/{id}` | Get workflow by id +[**get-workflow-execution**](#get-workflow-execution) | **Get** `/workflow-executions/{id}` | Get workflow execution +[**get-workflow-execution-history**](#get-workflow-execution-history) | **Get** `/workflow-executions/{id}/history` | Get workflow execution history +[**get-workflow-executions**](#get-workflow-executions) | **Get** `/workflows/{id}/executions` | List workflow executions +[**list-complete-workflow-library**](#list-complete-workflow-library) | **Get** `/workflow-library` | List complete workflow library +[**list-workflow-library-actions**](#list-workflow-library-actions) | **Get** `/workflow-library/actions` | List workflow library actions +[**list-workflow-library-operators**](#list-workflow-library-operators) | **Get** `/workflow-library/operators` | List workflow library operators +[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **Get** `/workflow-library/triggers` | List workflow library triggers +[**list-workflows**](#list-workflows) | **Get** `/workflows` | List workflows +[**patch-workflow**](#patch-workflow) | **Patch** `/workflows/{id}` | Patch workflow +[**post-external-execute-workflow**](#post-external-execute-workflow) | **Post** `/workflows/execute/external/{id}` | Execute workflow via external trigger +[**post-workflow-external-trigger**](#post-workflow-external-trigger) | **Post** `/workflows/{id}/external/oauth-clients` | Generate external trigger oauth client +[**put-workflow**](#put-workflow) | **Put** `/workflows/{id}` | Update workflow +[**test-external-execute-workflow**](#test-external-execute-workflow) | **Post** `/workflows/execute/external/{id}/test` | Test workflow via external trigger +[**test-workflow**](#test-workflow) | **Post** `/workflows/{id}/test` | Test workflow by id ## cancel-workflow-execution -Cancel Workflow Execution by ID +Cancel workflow execution by id Use this API to cancel a running workflow execution. [API Spec](https://developer.sailpoint.com/docs/api/beta/cancel-workflow-execution) @@ -102,7 +102,7 @@ func main() { [[Back to top]](#) ## create-workflow -Create Workflow +Create workflow Create a new workflow with the desired trigger and steps specified in the request body. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-workflow) @@ -169,7 +169,7 @@ func main() { [[Back to top]](#) ## delete-workflow -Delete Workflow By Id +Delete workflow by id Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workflow) @@ -234,7 +234,7 @@ func main() { [[Back to top]](#) ## get-workflow -Get Workflow By Id +Get workflow by id Get a single workflow by id. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow) @@ -302,7 +302,7 @@ func main() { [[Back to top]](#) ## get-workflow-execution -Get Workflow Execution +Get workflow execution Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution) @@ -368,7 +368,7 @@ func main() { [[Back to top]](#) ## get-workflow-execution-history -Get Workflow Execution History +Get workflow execution history Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution-history) @@ -434,7 +434,7 @@ func main() { [[Back to top]](#) ## get-workflow-executions -List Workflow Executions +List workflow executions Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. @@ -518,7 +518,7 @@ func main() { [[Back to top]](#) ## list-complete-workflow-library -List Complete Workflow Library +List complete workflow library This lists all triggers, actions, and operators in the library [API Spec](https://developer.sailpoint.com/docs/api/beta/list-complete-workflow-library) @@ -582,7 +582,7 @@ func main() { [[Back to top]](#) ## list-workflow-library-actions -List Workflow Library Actions +List workflow library actions This lists the workflow actions available to you. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-actions) @@ -648,7 +648,7 @@ func main() { [[Back to top]](#) ## list-workflow-library-operators -List Workflow Library Operators +List workflow library operators This lists the workflow operators available to you [API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-operators) @@ -705,7 +705,7 @@ func main() { [[Back to top]](#) ## list-workflow-library-triggers -List Workflow Library Triggers +List workflow library triggers This lists the workflow triggers available to you [API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-triggers) @@ -771,7 +771,7 @@ func main() { [[Back to top]](#) ## list-workflows -List Workflows +List workflows List all workflows in the tenant. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflows) @@ -839,7 +839,7 @@ func main() { [[Back to top]](#) ## patch-workflow -Patch Workflow +Patch workflow Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. [API Spec](https://developer.sailpoint.com/docs/api/beta/patch-workflow) @@ -912,7 +912,7 @@ func main() { [[Back to top]](#) ## post-external-execute-workflow -Execute Workflow via External Trigger +Execute workflow via external trigger This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. [API Spec](https://developer.sailpoint.com/docs/api/beta/post-external-execute-workflow) @@ -980,7 +980,7 @@ func main() { [[Back to top]](#) ## post-workflow-external-trigger -Generate External Trigger OAuth Client +Generate external trigger oauth client Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. [API Spec](https://developer.sailpoint.com/docs/api/beta/post-workflow-external-trigger) @@ -1046,7 +1046,7 @@ func main() { [[Back to top]](#) ## put-workflow -Update Workflow +Update workflow Perform a full update of a workflow. The updated workflow object is returned in the response. [API Spec](https://developer.sailpoint.com/docs/api/beta/put-workflow) @@ -1152,7 +1152,7 @@ func main() { [[Back to top]](#) ## test-external-execute-workflow -Test Workflow via External Trigger +Test workflow via external trigger Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. [API Spec](https://developer.sailpoint.com/docs/api/beta/test-external-execute-workflow) @@ -1220,7 +1220,7 @@ func main() { [[Back to top]](#) ## test-workflow -Test Workflow By Id +Test workflow by id Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccessModelMetadataAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccessModelMetadataAPI.md index 11202658e..57565ec15 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/AccessModelMetadataAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccessModelMetadataAPI.md @@ -25,10 +25,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-access-model-metadata-attribute**](#get-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute -[**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value -[**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes` | List Access Model Metadata Attributes -[**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values +[**get-access-model-metadata-attribute**](#get-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes/{key}` | Get access model metadata attribute +[**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values/{value}` | Get access model metadata value +[**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes` | List access model metadata attributes +[**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values` | List access model metadata values ## get-access-model-metadata-attribute @@ -43,7 +43,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Access Model Metadata Attribute +Get access model metadata attribute Get single Access Model Metadata Attribute [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute) @@ -122,7 +122,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Access Model Metadata Value +Get access model metadata value Get single Access Model Metadata Attribute Value [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute-value) @@ -204,7 +204,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Access Model Metadata Attributes +List access model metadata attributes Get a list of Access Model Metadata Attributes [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute) @@ -279,7 +279,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Access Model Metadata Values +List access model metadata values Get a list of Access Model Metadata Attribute Values [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute-value) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccessProfilesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccessProfilesAPI.md index 287c2cb00..ae1c27cf8 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/AccessProfilesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccessProfilesAPI.md @@ -49,18 +49,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-access-profile**](#create-access-profile) | **Post** `/access-profiles` | Create Access Profile -[**delete-access-profile**](#delete-access-profile) | **Delete** `/access-profiles/{id}` | Delete the specified Access Profile -[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-delete` | Delete Access Profile(s) -[**get-access-profile**](#get-access-profile) | **Get** `/access-profiles/{id}` | Get an Access Profile -[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **Get** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements -[**list-access-profiles**](#list-access-profiles) | **Get** `/access-profiles` | List Access Profiles -[**patch-access-profile**](#patch-access-profile) | **Patch** `/access-profiles/{id}` | Patch a specified Access Profile -[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. +[**create-access-profile**](#create-access-profile) | **Post** `/access-profiles` | Create access profile +[**delete-access-profile**](#delete-access-profile) | **Delete** `/access-profiles/{id}` | Delete the specified access profile +[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-delete` | Delete access profile(s) +[**get-access-profile**](#get-access-profile) | **Get** `/access-profiles/{id}` | Get an access profile +[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **Get** `/access-profiles/{id}/entitlements` | List access profile's entitlements +[**list-access-profiles**](#list-access-profiles) | **Get** `/access-profiles` | List access profiles +[**patch-access-profile**](#patch-access-profile) | **Patch** `/access-profiles/{id}` | Patch a specified access profile +[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-update-requestable` | Update access profile(s) requestable field. ## create-access-profile -Create Access Profile +Create access profile Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. @@ -215,7 +215,7 @@ func main() { [[Back to top]](#) ## delete-access-profile -Delete the specified Access Profile +Delete the specified access profile This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. @@ -284,7 +284,7 @@ func main() { [[Back to top]](#) ## delete-access-profiles-in-bulk -Delete Access Profile(s) +Delete access profile(s) This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. @@ -358,7 +358,7 @@ func main() { [[Back to top]](#) ## get-access-profile -Get an Access Profile +Get an access profile This API returns an Access Profile by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-profile) @@ -424,7 +424,7 @@ func main() { [[Back to top]](#) ## get-access-profile-entitlements -List Access Profile's Entitlements +List access profile's entitlements Use this API to get a list of an access profile's entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. @@ -502,7 +502,7 @@ func main() { [[Back to top]](#) ## list-access-profiles -List Access Profiles +List access profiles Get a list of access profiles. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. @@ -579,7 +579,7 @@ func main() { [[Back to top]](#) ## patch-access-profile -Patch a specified Access Profile +Patch a specified access profile This API updates an existing Access Profile. The following fields are patchable: **name** @@ -692,7 +692,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Access Profile(s) requestable field. +Update access profile(s) requestable field. This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestApprovalsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestApprovalsAPI.md index beb389f5a..7b54a6e9d 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestApprovalsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestApprovalsAPI.md @@ -32,17 +32,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-access-request**](#approve-access-request) | **Post** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval -[**forward-access-request**](#forward-access-request) | **Post** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval -[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **Get** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number -[**list-access-request-approvers**](#list-access-request-approvers) | **Get** `/access-request-approvals/{accessRequestId}/approvers` | Access Request Approvers -[**list-completed-approvals**](#list-completed-approvals) | **Get** `/access-request-approvals/completed` | Completed Access Request Approvals List -[**list-pending-approvals**](#list-pending-approvals) | **Get** `/access-request-approvals/pending` | Pending Access Request Approvals List -[**reject-access-request**](#reject-access-request) | **Post** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval +[**approve-access-request**](#approve-access-request) | **Post** `/access-request-approvals/{approvalId}/approve` | Approve access request approval +[**forward-access-request**](#forward-access-request) | **Post** `/access-request-approvals/{approvalId}/forward` | Forward access request approval +[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **Get** `/access-request-approvals/approval-summary` | Get access requests approvals number +[**list-access-request-approvers**](#list-access-request-approvers) | **Get** `/access-request-approvals/{accessRequestId}/approvers` | Access request approvers +[**list-completed-approvals**](#list-completed-approvals) | **Get** `/access-request-approvals/completed` | Completed access request approvals list +[**list-pending-approvals**](#list-pending-approvals) | **Get** `/access-request-approvals/pending` | Pending access request approvals list +[**reject-access-request**](#reject-access-request) | **Post** `/access-request-approvals/{approvalId}/reject` | Reject access request approval ## approve-access-request -Approve Access Request Approval +Approve access request approval Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. [API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-access-request) @@ -118,7 +118,7 @@ func main() { [[Back to top]](#) ## forward-access-request -Forward Access Request Approval +Forward access request approval Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. [API Spec](https://developer.sailpoint.com/docs/api/v2024/forward-access-request) @@ -194,7 +194,7 @@ func main() { [[Back to top]](#) ## get-access-request-approval-summary -Get Access Requests Approvals Number +Get access requests approvals number Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-approval-summary) @@ -258,7 +258,7 @@ func main() { [[Back to top]](#) ## list-access-request-approvers -Access Request Approvers +Access request approvers This API endpoint returns the list of approvers for the given access request id. @@ -331,7 +331,7 @@ func main() { [[Back to top]](#) ## list-completed-approvals -Completed Access Request Approvals List +Completed access request approvals list This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-completed-approvals) @@ -403,7 +403,7 @@ func main() { [[Back to top]](#) ## list-pending-approvals -Pending Access Request Approvals List +Pending access request approvals list This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-pending-approvals) @@ -475,7 +475,7 @@ func main() { [[Back to top]](#) ## reject-access-request -Reject Access Request Approval +Reject access request approval Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. [API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-access-request) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestsAPI.md index 713bd57b8..bcc88f75f 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestsAPI.md @@ -30,20 +30,20 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-bulk-access-request**](#approve-bulk-access-request) | **Post** `/access-request-approvals/bulk-approve` | Bulk Approve Access Request -[**cancel-access-request**](#cancel-access-request) | **Post** `/access-requests/cancel` | Cancel Access Request -[**cancel-access-request-in-bulk**](#cancel-access-request-in-bulk) | **Post** `/access-requests/bulk-cancel` | Bulk Cancel Access Request -[**close-access-request**](#close-access-request) | **Post** `/access-requests/close` | Close Access Request -[**create-access-request**](#create-access-request) | **Post** `/access-requests` | Submit Access Request -[**get-access-request-config**](#get-access-request-config) | **Get** `/access-request-config` | Get Access Request Configuration -[**list-access-request-status**](#list-access-request-status) | **Get** `/access-request-status` | Access Request Status -[**list-administrators-access-request-status**](#list-administrators-access-request-status) | **Get** `/access-request-administration` | Access Request Status for Administrators +[**approve-bulk-access-request**](#approve-bulk-access-request) | **Post** `/access-request-approvals/bulk-approve` | Bulk approve access request +[**cancel-access-request**](#cancel-access-request) | **Post** `/access-requests/cancel` | Cancel access request +[**cancel-access-request-in-bulk**](#cancel-access-request-in-bulk) | **Post** `/access-requests/bulk-cancel` | Bulk cancel access request +[**close-access-request**](#close-access-request) | **Post** `/access-requests/close` | Close access request +[**create-access-request**](#create-access-request) | **Post** `/access-requests` | Submit access request +[**get-access-request-config**](#get-access-request-config) | **Get** `/access-request-config` | Get access request configuration +[**list-access-request-status**](#list-access-request-status) | **Get** `/access-request-status` | Access request status +[**list-administrators-access-request-status**](#list-administrators-access-request-status) | **Get** `/access-request-administration` | Access request status for administrators [**load-account-selections**](#load-account-selections) | **Post** `/access-requests/accounts-selection` | Get accounts selections for identity -[**set-access-request-config**](#set-access-request-config) | **Put** `/access-request-config` | Update Access Request Configuration +[**set-access-request-config**](#set-access-request-config) | **Put** `/access-request-config` | Update access request configuration ## approve-bulk-access-request -Bulk Approve Access Request +Bulk approve access request This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights "idn:access-request-administration:write" can approve the access requests in bulk. [API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-bulk-access-request) @@ -113,7 +113,7 @@ func main() { [[Back to top]](#) ## cancel-access-request -Cancel Access Request +Cancel access request This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. @@ -184,7 +184,7 @@ func main() { [[Back to top]](#) ## cancel-access-request-in-bulk -Bulk Cancel Access Request +Bulk cancel access request This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights "idn:access-request-administration:write" can cancel the access requests in bulk. @@ -266,7 +266,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Close Access Request +Close access request This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. @@ -351,7 +351,7 @@ func main() { [[Back to top]](#) ## create-access-request -Submit Access Request +Submit access request Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request @@ -633,7 +633,7 @@ func main() { [[Back to top]](#) ## get-access-request-config -Get Access Request Configuration +Get access request configuration This endpoint returns the current access-request configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-config) @@ -690,7 +690,7 @@ func main() { [[Back to top]](#) ## list-access-request-status -Access Request Status +Access request status Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. @@ -772,7 +772,7 @@ func main() { [[Back to top]](#) ## list-administrators-access-request-status -Access Request Status for Administrators +Access request status for administrators Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses @@ -986,7 +986,7 @@ func main() { [[Back to top]](#) ## set-access-request-config -Update Access Request Configuration +Update access request configuration This endpoint replaces the current access-request configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-config) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccountActivitiesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccountActivitiesAPI.md index 23e31e430..5d9e54b53 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/AccountActivitiesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccountActivitiesAPI.md @@ -48,12 +48,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-account-activity**](#get-account-activity) | **Get** `/account-activities/{id}` | Get an Account Activity -[**list-account-activities**](#list-account-activities) | **Get** `/account-activities` | List Account Activities +[**get-account-activity**](#get-account-activity) | **Get** `/account-activities/{id}` | Get an account activity +[**list-account-activities**](#list-account-activities) | **Get** `/account-activities` | List account activities ## get-account-activity -Get an Account Activity +Get an account activity This gets a single account activity by its id. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-activity) @@ -119,7 +119,7 @@ func main() { [[Back to top]](#) ## list-account-activities -List Account Activities +List account activities This gets a collection of account activities that satisfy the given query parameters. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-account-activities) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccountAggregationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccountAggregationsAPI.md index 6e987d2ed..f86e886a2 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/AccountAggregationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccountAggregationsAPI.md @@ -25,7 +25,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-account-aggregation-status**](#get-account-aggregation-status) | **Get** `/account-aggregations/{id}/status` | In-progress Account Aggregation status +[**get-account-aggregation-status**](#get-account-aggregation-status) | **Get** `/account-aggregations/{id}/status` | In-progress account aggregation status ## get-account-aggregation-status @@ -40,7 +40,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -In-progress Account Aggregation status +In-progress account aggregation status This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccountsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccountsAPI.md index 791d8e476..226ad32d4 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/AccountsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccountsAPI.md @@ -42,26 +42,26 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-account**](#create-account) | **Post** `/accounts` | Create Account -[**delete-account**](#delete-account) | **Delete** `/accounts/{id}` | Delete Account -[**delete-account-async**](#delete-account-async) | **Post** `/accounts/{id}/remove` | Remove Account -[**disable-account**](#disable-account) | **Post** `/accounts/{id}/disable` | Disable Account -[**disable-account-for-identity**](#disable-account-for-identity) | **Post** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity -[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **Post** `/identities-accounts/disable` | Disable IDN Accounts for Identities -[**enable-account**](#enable-account) | **Post** `/accounts/{id}/enable` | Enable Account -[**enable-account-for-identity**](#enable-account-for-identity) | **Post** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity -[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **Post** `/identities-accounts/enable` | Enable IDN Accounts for Identities -[**get-account**](#get-account) | **Get** `/accounts/{id}` | Account Details -[**get-account-entitlements**](#get-account-entitlements) | **Get** `/accounts/{id}/entitlements` | Account Entitlements -[**list-accounts**](#list-accounts) | **Get** `/accounts` | Accounts List -[**put-account**](#put-account) | **Put** `/accounts/{id}` | Update Account -[**submit-reload-account**](#submit-reload-account) | **Post** `/accounts/{id}/reload` | Reload Account -[**unlock-account**](#unlock-account) | **Post** `/accounts/{id}/unlock` | Unlock Account -[**update-account**](#update-account) | **Patch** `/accounts/{id}` | Update Account +[**create-account**](#create-account) | **Post** `/accounts` | Create account +[**delete-account**](#delete-account) | **Delete** `/accounts/{id}` | Delete account +[**delete-account-async**](#delete-account-async) | **Post** `/accounts/{id}/remove` | Remove account +[**disable-account**](#disable-account) | **Post** `/accounts/{id}/disable` | Disable account +[**disable-account-for-identity**](#disable-account-for-identity) | **Post** `/identities-accounts/{id}/disable` | Disable idn account for identity +[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **Post** `/identities-accounts/disable` | Disable idn accounts for identities +[**enable-account**](#enable-account) | **Post** `/accounts/{id}/enable` | Enable account +[**enable-account-for-identity**](#enable-account-for-identity) | **Post** `/identities-accounts/{id}/enable` | Enable idn account for identity +[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **Post** `/identities-accounts/enable` | Enable idn accounts for identities +[**get-account**](#get-account) | **Get** `/accounts/{id}` | Account details +[**get-account-entitlements**](#get-account-entitlements) | **Get** `/accounts/{id}/entitlements` | Account entitlements +[**list-accounts**](#list-accounts) | **Get** `/accounts` | Accounts list +[**put-account**](#put-account) | **Put** `/accounts/{id}` | Update account +[**submit-reload-account**](#submit-reload-account) | **Post** `/accounts/{id}/reload` | Reload account +[**unlock-account**](#unlock-account) | **Post** `/accounts/{id}/unlock` | Unlock account +[**update-account**](#update-account) | **Patch** `/accounts/{id}` | Update account ## create-account -Create Account +Create account Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. @@ -148,7 +148,7 @@ func main() { [[Back to top]](#) ## delete-account -Delete Account +Delete account Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. @@ -228,7 +228,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Remove Account +Remove account Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: @@ -302,7 +302,7 @@ func main() { [[Back to top]](#) ## disable-account -Disable Account +Disable account This API submits a task to disable the account and returns the task ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-account) @@ -389,7 +389,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Disable IDN Account for Identity +Disable idn account for identity This API submits a task to disable IDN account for a single identity. [API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-account-for-identity) @@ -468,7 +468,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Disable IDN Accounts for Identities +Disable idn accounts for identities This API submits tasks to disable IDN account for each identity provided in the request body. [API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-accounts-for-identities) @@ -539,7 +539,7 @@ func main() { [[Back to top]](#) ## enable-account -Enable Account +Enable account This API submits a task to enable account and returns the task ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-account) @@ -626,7 +626,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Enable IDN Account for Identity +Enable idn account for identity This API submits a task to enable IDN account for a single identity. [API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-account-for-identity) @@ -705,7 +705,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Enable IDN Accounts for Identities +Enable idn accounts for identities This API submits tasks to enable IDN account for each identity provided in the request body. [API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-accounts-for-identities) @@ -776,7 +776,7 @@ func main() { [[Back to top]](#) ## get-account -Account Details +Account details Use this API to return the details for a single account by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account) @@ -842,7 +842,7 @@ func main() { [[Back to top]](#) ## get-account-entitlements -Account Entitlements +Account entitlements This API returns entitlements of the account. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-entitlements) @@ -914,7 +914,7 @@ func main() { [[Back to top]](#) ## list-accounts -Accounts List +Accounts list List accounts. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-accounts) @@ -986,7 +986,7 @@ func main() { [[Back to top]](#) ## put-account -Update Account +Update account Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. @@ -1072,7 +1072,7 @@ func main() { [[Back to top]](#) ## submit-reload-account -Reload Account +Reload account This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. [API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-reload-account) @@ -1138,7 +1138,7 @@ func main() { [[Back to top]](#) ## unlock-account -Unlock Account +Unlock account This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. @@ -1216,7 +1216,7 @@ func main() { [[Back to top]](#) ## update-account -Update Account +Update account Use this API to update account details. This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ApplicationDiscoveryAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ApplicationDiscoveryAPI.md index 019463b3e..8b2f6d024 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/ApplicationDiscoveryAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ApplicationDiscoveryAPI.md @@ -17,13 +17,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-discovered-applications**](#get-discovered-applications) | **Get** `/discovered-applications` | Get Discovered Applications for Tenant -[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **Get** `/manual-discover-applications-template` | Download CSV Template for Discovery -[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **Post** `/manual-discover-applications` | Upload CSV to Discover Applications +[**get-discovered-applications**](#get-discovered-applications) | **Get** `/discovered-applications` | Get discovered applications for tenant +[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **Get** `/manual-discover-applications-template` | Download csv template for discovery +[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **Post** `/manual-discover-applications` | Upload csv to discover applications ## get-discovered-applications -Get Discovered Applications for Tenant +Get discovered applications for tenant Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. @@ -94,7 +94,7 @@ func main() { [[Back to top]](#) ## get-manual-discover-applications-csv-template -Download CSV Template for Discovery +Download csv template for discovery Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. @@ -154,7 +154,7 @@ func main() { [[Back to top]](#) ## send-manual-discover-applications-csv-template -Upload CSV to Discover Applications +Upload csv to discover applications Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ApprovalsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ApprovalsAPI.md index 7a510eadf..39da0cbf3 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/ApprovalsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ApprovalsAPI.md @@ -19,7 +19,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**get-approval**](#get-approval) | **Get** `/generic-approvals/{id}` | Get an approval -[**get-approvals**](#get-approvals) | **Get** `/generic-approvals` | Get Approvals +[**get-approvals**](#get-approvals) | **Get** `/generic-approvals` | Get approvals ## get-approval @@ -113,7 +113,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Approvals +Get approvals Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. "Mine" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. Absence of all query parameters will will default to mine=true. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AppsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AppsAPI.md index 2a7bc1742..84e21f5f6 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/AppsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AppsAPI.md @@ -19,8 +19,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create-source-app**](#create-source-app) | **Post** `/source-apps` | Create source app [**delete-access-profiles-from-source-app-by-bulk**](#delete-access-profiles-from-source-app-by-bulk) | **Post** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app -[**delete-source-app**](#delete-source-app) | **Delete** `/source-apps/{id}` | Delete source app by ID -[**get-source-app**](#get-source-app) | **Get** `/source-apps/{id}` | Get source app by ID +[**delete-source-app**](#delete-source-app) | **Delete** `/source-apps/{id}` | Delete source app by id +[**get-source-app**](#get-source-app) | **Get** `/source-apps/{id}` | Get source app by id [**list-access-profiles-for-source-app**](#list-access-profiles-for-source-app) | **Get** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app [**list-all-source-app**](#list-all-source-app) | **Get** `/source-apps/all` | List all source apps [**list-all-user-apps**](#list-all-user-apps) | **Get** `/user-apps/all` | List all user apps @@ -28,8 +28,8 @@ Method | HTTP request | Description [**list-available-accounts-for-user-app**](#list-available-accounts-for-user-app) | **Get** `/user-apps/{id}/available-accounts` | List available accounts for user app [**list-available-source-apps**](#list-available-source-apps) | **Get** `/source-apps` | List available source apps [**list-owned-user-apps**](#list-owned-user-apps) | **Get** `/user-apps` | List owned user apps -[**patch-source-app**](#patch-source-app) | **Patch** `/source-apps/{id}` | Patch source app by ID -[**patch-user-app**](#patch-user-app) | **Patch** `/user-apps/{id}` | Patch user app by ID +[**patch-source-app**](#patch-source-app) | **Patch** `/source-apps/{id}` | Patch source app by id +[**patch-user-app**](#patch-user-app) | **Patch** `/user-apps/{id}` | Patch user app by id [**update-source-apps-in-bulk**](#update-source-apps-in-bulk) | **Post** `/source-apps/bulk-update` | Bulk update source apps @@ -222,7 +222,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete source app by ID +Delete source app by id Use this API to delete a specific source app [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-app) @@ -301,7 +301,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get source app by ID +Get source app by id This API returns a source app by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-app) @@ -960,7 +960,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch source app by ID +Patch source app by id This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can't be empty or null. @@ -1043,7 +1043,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch user app by ID +Patch user app by id This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AuthProfileAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AuthProfileAPI.md index def4be782..1f9c89a74 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/AuthProfileAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AuthProfileAPI.md @@ -21,9 +21,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-profile-config**](#get-profile-config) | **Get** `/auth-profiles/{id}` | Get Auth Profile -[**get-profile-config-list**](#get-profile-config-list) | **Get** `/auth-profiles` | Get list of Auth Profiles -[**patch-profile-config**](#patch-profile-config) | **Patch** `/auth-profiles/{id}` | Patch a specified Auth Profile +[**get-profile-config**](#get-profile-config) | **Get** `/auth-profiles/{id}` | Get auth profile +[**get-profile-config-list**](#get-profile-config-list) | **Get** `/auth-profiles` | Get list of auth profiles +[**patch-profile-config**](#patch-profile-config) | **Patch** `/auth-profiles/{id}` | Patch a specified auth profile ## get-profile-config @@ -38,7 +38,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Auth Profile +Get auth profile This API returns auth profile information. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config) @@ -117,7 +117,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get list of Auth Profiles +Get list of auth profiles This API returns a list of auth profiles. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config-list) @@ -190,7 +190,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch a specified Auth Profile +Patch a specified auth profile This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AuthUsersAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AuthUsersAPI.md index 6355d69a7..f772c2928 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/AuthUsersAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AuthUsersAPI.md @@ -20,12 +20,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-auth-user**](#get-auth-user) | **Get** `/auth-users/{id}` | Auth User Details -[**patch-auth-user**](#patch-auth-user) | **Patch** `/auth-users/{id}` | Auth User Update +[**get-auth-user**](#get-auth-user) | **Get** `/auth-users/{id}` | Auth user details +[**patch-auth-user**](#patch-auth-user) | **Patch** `/auth-users/{id}` | Auth user update ## get-auth-user -Auth User Details +Auth user details Return the specified user's authentication system details. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-user) @@ -91,7 +91,7 @@ func main() { [[Back to top]](#) ## patch-auth-user -Auth User Update +Auth user update Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignFiltersAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignFiltersAPI.md index a27eebed0..9b41d5e63 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignFiltersAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignFiltersAPI.md @@ -42,15 +42,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-campaign-filter**](#create-campaign-filter) | **Post** `/campaign-filters` | Create Campaign Filter -[**delete-campaign-filters**](#delete-campaign-filters) | **Post** `/campaign-filters/delete` | Deletes Campaign Filters -[**get-campaign-filter-by-id**](#get-campaign-filter-by-id) | **Get** `/campaign-filters/{id}` | Get Campaign Filter by ID -[**list-campaign-filters**](#list-campaign-filters) | **Get** `/campaign-filters` | List Campaign Filters -[**update-campaign-filter**](#update-campaign-filter) | **Post** `/campaign-filters/{id}` | Updates a Campaign Filter +[**create-campaign-filter**](#create-campaign-filter) | **Post** `/campaign-filters` | Create campaign filter +[**delete-campaign-filters**](#delete-campaign-filters) | **Post** `/campaign-filters/delete` | Deletes campaign filters +[**get-campaign-filter-by-id**](#get-campaign-filter-by-id) | **Get** `/campaign-filters/{id}` | Get campaign filter by id +[**list-campaign-filters**](#list-campaign-filters) | **Get** `/campaign-filters` | List campaign filters +[**update-campaign-filter**](#update-campaign-filter) | **Post** `/campaign-filters/{id}` | Updates a campaign filter ## create-campaign-filter -Create Campaign Filter +Create campaign filter Use this API to create a campaign filter based on filter details and criteria. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-campaign-filter) @@ -134,7 +134,7 @@ func main() { [[Back to top]](#) ## delete-campaign-filters -Deletes Campaign Filters +Deletes campaign filters Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-campaign-filters) @@ -200,7 +200,7 @@ func main() { [[Back to top]](#) ## get-campaign-filter-by-id -Get Campaign Filter by ID +Get campaign filter by id Retrieves information for an existing campaign filter using the filter's ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-filter-by-id) @@ -266,7 +266,7 @@ func main() { [[Back to top]](#) ## list-campaign-filters -List Campaign Filters +List campaign filters Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-campaign-filters) @@ -332,7 +332,7 @@ func main() { [[Back to top]](#) ## update-campaign-filter -Updates a Campaign Filter +Updates a campaign filter Updates an existing campaign filter using the filter's ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/update-campaign-filter) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignsAPI.md index 8b2a3040d..f8fa33b8d 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignsAPI.md @@ -80,32 +80,32 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**complete-campaign**](#complete-campaign) | **Post** `/campaigns/{id}/complete` | Complete a Campaign +[**complete-campaign**](#complete-campaign) | **Post** `/campaigns/{id}/complete` | Complete a campaign [**create-campaign**](#create-campaign) | **Post** `/campaigns` | Create a campaign -[**create-campaign-template**](#create-campaign-template) | **Post** `/campaign-templates` | Create a Campaign Template -[**delete-campaign-template**](#delete-campaign-template) | **Delete** `/campaign-templates/{id}` | Delete a Campaign Template -[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **Delete** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule -[**delete-campaigns**](#delete-campaigns) | **Post** `/campaigns/delete` | Delete Campaigns -[**get-active-campaigns**](#get-active-campaigns) | **Get** `/campaigns` | List Campaigns -[**get-campaign**](#get-campaign) | **Get** `/campaigns/{id}` | Get Campaign -[**get-campaign-reports**](#get-campaign-reports) | **Get** `/campaigns/{id}/reports` | Get Campaign Reports -[**get-campaign-reports-config**](#get-campaign-reports-config) | **Get** `/campaigns/reports-configuration` | Get Campaign Reports Configuration -[**get-campaign-template**](#get-campaign-template) | **Get** `/campaign-templates/{id}` | Get a Campaign Template -[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **Get** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule -[**get-campaign-templates**](#get-campaign-templates) | **Get** `/campaign-templates` | List Campaign Templates -[**move**](#move) | **Post** `/campaigns/{id}/reassign` | Reassign Certifications -[**patch-campaign-template**](#patch-campaign-template) | **Patch** `/campaign-templates/{id}` | Update a Campaign Template -[**set-campaign-reports-config**](#set-campaign-reports-config) | **Put** `/campaigns/reports-configuration` | Set Campaign Reports Configuration -[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **Put** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule -[**start-campaign**](#start-campaign) | **Post** `/campaigns/{id}/activate` | Activate a Campaign -[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **Post** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan -[**start-campaign-report**](#start-campaign-report) | **Post** `/campaigns/{id}/run-report/{type}` | Run Campaign Report -[**start-generate-campaign-template**](#start-generate-campaign-template) | **Post** `/campaign-templates/{id}/generate` | Generate a Campaign from Template -[**update-campaign**](#update-campaign) | **Patch** `/campaigns/{id}` | Update a Campaign +[**create-campaign-template**](#create-campaign-template) | **Post** `/campaign-templates` | Create a campaign template +[**delete-campaign-template**](#delete-campaign-template) | **Delete** `/campaign-templates/{id}` | Delete a campaign template +[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **Delete** `/campaign-templates/{id}/schedule` | Delete campaign template schedule +[**delete-campaigns**](#delete-campaigns) | **Post** `/campaigns/delete` | Delete campaigns +[**get-active-campaigns**](#get-active-campaigns) | **Get** `/campaigns` | List campaigns +[**get-campaign**](#get-campaign) | **Get** `/campaigns/{id}` | Get campaign +[**get-campaign-reports**](#get-campaign-reports) | **Get** `/campaigns/{id}/reports` | Get campaign reports +[**get-campaign-reports-config**](#get-campaign-reports-config) | **Get** `/campaigns/reports-configuration` | Get campaign reports configuration +[**get-campaign-template**](#get-campaign-template) | **Get** `/campaign-templates/{id}` | Get a campaign template +[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **Get** `/campaign-templates/{id}/schedule` | Get campaign template schedule +[**get-campaign-templates**](#get-campaign-templates) | **Get** `/campaign-templates` | List campaign templates +[**move**](#move) | **Post** `/campaigns/{id}/reassign` | Reassign certifications +[**patch-campaign-template**](#patch-campaign-template) | **Patch** `/campaign-templates/{id}` | Update a campaign template +[**set-campaign-reports-config**](#set-campaign-reports-config) | **Put** `/campaigns/reports-configuration` | Set campaign reports configuration +[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **Put** `/campaign-templates/{id}/schedule` | Set campaign template schedule +[**start-campaign**](#start-campaign) | **Post** `/campaigns/{id}/activate` | Activate a campaign +[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **Post** `/campaigns/{id}/run-remediation-scan` | Run campaign remediation scan +[**start-campaign-report**](#start-campaign-report) | **Post** `/campaigns/{id}/run-report/{type}` | Run campaign report +[**start-generate-campaign-template**](#start-generate-campaign-template) | **Post** `/campaign-templates/{id}/generate` | Generate a campaign from template +[**update-campaign**](#update-campaign) | **Patch** `/campaigns/{id}` | Update a campaign ## complete-campaign -Complete a Campaign +Complete a campaign :::caution This endpoint will run successfully for any campaigns that are **past due**. @@ -362,7 +362,7 @@ func main() { [[Back to top]](#) ## create-campaign-template -Create a Campaign Template +Create a campaign template Use this API to create a certification campaign template based on campaign. @@ -555,7 +555,7 @@ func main() { [[Back to top]](#) ## delete-campaign-template -Delete a Campaign Template +Delete a campaign template Use this API to delete a certification campaign template by ID. @@ -621,7 +621,7 @@ func main() { [[Back to top]](#) ## delete-campaign-template-schedule -Delete Campaign Template Schedule +Delete campaign template schedule Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. @@ -687,7 +687,7 @@ func main() { [[Back to top]](#) ## delete-campaigns -Delete Campaigns +Delete campaigns Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. @@ -757,7 +757,7 @@ func main() { [[Back to top]](#) ## get-active-campaigns -List Campaigns +List campaigns Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. @@ -830,7 +830,7 @@ func main() { [[Back to top]](#) ## get-campaign -Get Campaign +Get campaign Use this API to get information for an existing certification campaign by the campaign's ID. @@ -899,7 +899,7 @@ func main() { [[Back to top]](#) ## get-campaign-reports -Get Campaign Reports +Get campaign reports Use this API to fetch all reports for a certification campaign by campaign ID. @@ -966,7 +966,7 @@ func main() { [[Back to top]](#) ## get-campaign-reports-config -Get Campaign Reports Configuration +Get campaign reports configuration Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. @@ -1024,7 +1024,7 @@ func main() { [[Back to top]](#) ## get-campaign-template -Get a Campaign Template +Get a campaign template Use this API to fetch a certification campaign template by ID. @@ -1091,7 +1091,7 @@ func main() { [[Back to top]](#) ## get-campaign-template-schedule -Get Campaign Template Schedule +Get campaign template schedule Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. @@ -1158,7 +1158,7 @@ func main() { [[Back to top]](#) ## get-campaign-templates -List Campaign Templates +List campaign templates Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. @@ -1231,7 +1231,7 @@ func main() { [[Back to top]](#) ## move -Reassign Certifications +Reassign certifications This API reassigns the specified certifications from one identity to another. @@ -1312,7 +1312,7 @@ func main() { [[Back to top]](#) ## patch-campaign-template -Update a Campaign Template +Update a campaign template Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. @@ -1386,7 +1386,7 @@ func main() { [[Back to top]](#) ## set-campaign-reports-config -Set Campaign Reports Configuration +Set campaign reports configuration Use this API to overwrite the configuration for campaign reports. @@ -1456,7 +1456,7 @@ func main() { [[Back to top]](#) ## set-campaign-template-schedule -Set Campaign Template Schedule +Set campaign template schedule Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. @@ -1543,7 +1543,7 @@ func main() { [[Back to top]](#) ## start-campaign -Activate a Campaign +Activate a campaign Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. @@ -1614,7 +1614,7 @@ func main() { [[Back to top]](#) ## start-campaign-remediation-scan -Run Campaign Remediation Scan +Run campaign remediation scan Use this API to run a remediation scan task for a certification campaign. @@ -1681,7 +1681,7 @@ func main() { [[Back to top]](#) ## start-campaign-report -Run Campaign Report +Run campaign report Use this API to run a report for a certification campaign. @@ -1751,7 +1751,7 @@ func main() { [[Back to top]](#) ## start-generate-campaign-template -Generate a Campaign from Template +Generate a campaign from template Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description @@ -1828,7 +1828,7 @@ func main() { [[Back to top]](#) ## update-campaign -Update a Campaign +Update a campaign Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/CertificationSummariesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationSummariesAPI.md index 03d2f6b43..d5d22679d 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/CertificationSummariesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationSummariesAPI.md @@ -29,14 +29,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-identity-access-summaries**](#get-identity-access-summaries) | **Get** `/certifications/{id}/access-summaries/{type}` | Access Summaries -[**get-identity-decision-summary**](#get-identity-decision-summary) | **Get** `/certifications/{id}/decision-summary` | Summary of Certification Decisions -[**get-identity-summaries**](#get-identity-summaries) | **Get** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification -[**get-identity-summary**](#get-identity-summary) | **Get** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity +[**get-identity-access-summaries**](#get-identity-access-summaries) | **Get** `/certifications/{id}/access-summaries/{type}` | Access summaries +[**get-identity-decision-summary**](#get-identity-decision-summary) | **Get** `/certifications/{id}/decision-summary` | Summary of certification decisions +[**get-identity-summaries**](#get-identity-summaries) | **Get** `/certifications/{id}/identity-summaries` | Identity summaries for campaign certification +[**get-identity-summary**](#get-identity-summary) | **Get** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for identity ## get-identity-access-summaries -Access Summaries +Access summaries This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-access-summaries) @@ -115,7 +115,7 @@ func main() { [[Back to top]](#) ## get-identity-decision-summary -Summary of Certification Decisions +Summary of certification decisions This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-decision-summary) @@ -183,7 +183,7 @@ func main() { [[Back to top]](#) ## get-identity-summaries -Identity Summaries for Campaign Certification +Identity summaries for campaign certification This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-summaries) @@ -259,7 +259,7 @@ func main() { [[Back to top]](#) ## get-identity-summary -Summary for Identity +Summary for identity This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-summary) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/CertificationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationsAPI.md index 24509b25d..d155300dc 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/CertificationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationsAPI.md @@ -38,21 +38,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-certification-task**](#get-certification-task) | **Get** `/certification-tasks/{id}` | Certification Task by ID -[**get-identity-certification**](#get-identity-certification) | **Get** `/certifications/{id}` | Identity Certification by ID -[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **Get** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item -[**get-pending-certification-tasks**](#get-pending-certification-tasks) | **Get** `/certification-tasks` | List of Pending Certification Tasks -[**list-certification-reviewers**](#list-certification-reviewers) | **Get** `/certifications/{id}/reviewers` | List of Reviewers for certification -[**list-identity-access-review-items**](#list-identity-access-review-items) | **Get** `/certifications/{id}/access-review-items` | List of Access Review Items -[**list-identity-certifications**](#list-identity-certifications) | **Get** `/certifications` | List Identity Campaign Certifications -[**make-identity-decision**](#make-identity-decision) | **Post** `/certifications/{id}/decide` | Decide on a Certification Item -[**reassign-identity-certifications**](#reassign-identity-certifications) | **Post** `/certifications/{id}/reassign` | Reassign Identities or Items -[**sign-off-identity-certification**](#sign-off-identity-certification) | **Post** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions -[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **Post** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously +[**get-certification-task**](#get-certification-task) | **Get** `/certification-tasks/{id}` | Certification task by id +[**get-identity-certification**](#get-identity-certification) | **Get** `/certifications/{id}` | Identity certification by id +[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **Get** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for entitlement certification item +[**get-pending-certification-tasks**](#get-pending-certification-tasks) | **Get** `/certification-tasks` | List of pending certification tasks +[**list-certification-reviewers**](#list-certification-reviewers) | **Get** `/certifications/{id}/reviewers` | List of reviewers for certification +[**list-identity-access-review-items**](#list-identity-access-review-items) | **Get** `/certifications/{id}/access-review-items` | List of access review items +[**list-identity-certifications**](#list-identity-certifications) | **Get** `/certifications` | List identity campaign certifications +[**make-identity-decision**](#make-identity-decision) | **Post** `/certifications/{id}/decide` | Decide on a certification item +[**reassign-identity-certifications**](#reassign-identity-certifications) | **Post** `/certifications/{id}/reassign` | Reassign identities or items +[**sign-off-identity-certification**](#sign-off-identity-certification) | **Post** `/certifications/{id}/sign-off` | Finalize identity certification decisions +[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **Post** `/certifications/{id}/reassign-async` | Reassign certifications asynchronously ## get-certification-task -Certification Task by ID +Certification task by id This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-certification-task) @@ -118,7 +118,7 @@ func main() { [[Back to top]](#) ## get-identity-certification -Identity Certification by ID +Identity certification by id This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-certification) @@ -184,7 +184,7 @@ func main() { [[Back to top]](#) ## get-identity-certification-item-permissions -Permissions for Entitlement Certification Item +Permissions for entitlement certification item This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-certification-item-permissions) @@ -261,7 +261,7 @@ func main() { [[Back to top]](#) ## get-pending-certification-tasks -List of Pending Certification Tasks +List of pending certification tasks This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-certification-tasks) @@ -331,7 +331,7 @@ func main() { [[Back to top]](#) ## list-certification-reviewers -List of Reviewers for certification +List of reviewers for certification This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-certification-reviewers) @@ -407,7 +407,7 @@ func main() { [[Back to top]](#) ## list-identity-access-review-items -List of Access Review Items +List of access review items This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-access-review-items) @@ -489,7 +489,7 @@ func main() { [[Back to top]](#) ## list-identity-certifications -List Identity Campaign Certifications +List identity campaign certifications Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-certifications) @@ -561,7 +561,7 @@ func main() { [[Back to top]](#) ## make-identity-decision -Decide on a Certification Item +Decide on a certification item The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v2024/make-identity-decision) @@ -634,7 +634,7 @@ func main() { [[Back to top]](#) ## reassign-identity-certifications -Reassign Identities or Items +Reassign identities or items This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v2024/reassign-identity-certifications) @@ -717,7 +717,7 @@ func main() { [[Back to top]](#) ## sign-off-identity-certification -Finalize Identity Certification Decisions +Finalize identity certification decisions This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v2024/sign-off-identity-certification) @@ -783,7 +783,7 @@ func main() { [[Back to top]](#) ## submit-reassign-certs-async -Reassign Certifications Asynchronously +Reassign certifications asynchronously This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ConfigurationHubAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ConfigurationHubAPI.md index ef729d987..e91170665 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/ConfigurationHubAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ConfigurationHubAPI.md @@ -26,30 +26,30 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-deploy**](#create-deploy) | **Post** `/configuration-hub/deploys` | Create a Deploy +[**create-deploy**](#create-deploy) | **Post** `/configuration-hub/deploys` | Create a deploy [**create-object-mapping**](#create-object-mapping) | **Post** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping [**create-object-mappings**](#create-object-mappings) | **Post** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings -[**create-scheduled-action**](#create-scheduled-action) | **Post** `/configuration-hub/scheduled-actions` | Create Scheduled Action -[**create-uploaded-configuration**](#create-uploaded-configuration) | **Post** `/configuration-hub/backups/uploads` | Upload a Configuration -[**delete-backup**](#delete-backup) | **Delete** `/configuration-hub/backups/{id}` | Delete a Backup +[**create-scheduled-action**](#create-scheduled-action) | **Post** `/configuration-hub/scheduled-actions` | Create scheduled action +[**create-uploaded-configuration**](#create-uploaded-configuration) | **Post** `/configuration-hub/backups/uploads` | Upload a configuration +[**delete-backup**](#delete-backup) | **Delete** `/configuration-hub/backups/{id}` | Delete a backup [**delete-draft**](#delete-draft) | **Delete** `/configuration-hub/drafts/{id}` | Delete a draft [**delete-object-mapping**](#delete-object-mapping) | **Delete** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping -[**delete-scheduled-action**](#delete-scheduled-action) | **Delete** `/configuration-hub/scheduled-actions/{id}` | Delete Scheduled Action -[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **Delete** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration -[**get-deploy**](#get-deploy) | **Get** `/configuration-hub/deploys/{id}` | Get a Deploy +[**delete-scheduled-action**](#delete-scheduled-action) | **Delete** `/configuration-hub/scheduled-actions/{id}` | Delete scheduled action +[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **Delete** `/configuration-hub/backups/uploads/{id}` | Delete an uploaded configuration +[**get-deploy**](#get-deploy) | **Get** `/configuration-hub/deploys/{id}` | Get a deploy [**get-object-mappings**](#get-object-mappings) | **Get** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings -[**get-uploaded-configuration**](#get-uploaded-configuration) | **Get** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration -[**list-backups**](#list-backups) | **Get** `/configuration-hub/backups` | List Backups -[**list-deploys**](#list-deploys) | **Get** `/configuration-hub/deploys` | List Deploys -[**list-drafts**](#list-drafts) | **Get** `/configuration-hub/drafts` | List Drafts -[**list-scheduled-actions**](#list-scheduled-actions) | **Get** `/configuration-hub/scheduled-actions` | List Scheduled Actions -[**list-uploaded-configurations**](#list-uploaded-configurations) | **Get** `/configuration-hub/backups/uploads` | List Uploaded Configurations +[**get-uploaded-configuration**](#get-uploaded-configuration) | **Get** `/configuration-hub/backups/uploads/{id}` | Get an uploaded configuration +[**list-backups**](#list-backups) | **Get** `/configuration-hub/backups` | List backups +[**list-deploys**](#list-deploys) | **Get** `/configuration-hub/deploys` | List deploys +[**list-drafts**](#list-drafts) | **Get** `/configuration-hub/drafts` | List drafts +[**list-scheduled-actions**](#list-scheduled-actions) | **Get** `/configuration-hub/scheduled-actions` | List scheduled actions +[**list-uploaded-configurations**](#list-uploaded-configurations) | **Get** `/configuration-hub/backups/uploads` | List uploaded configurations [**update-object-mappings**](#update-object-mappings) | **Post** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings -[**update-scheduled-action**](#update-scheduled-action) | **Patch** `/configuration-hub/scheduled-actions/{id}` | Update Scheduled Action +[**update-scheduled-action**](#update-scheduled-action) | **Patch** `/configuration-hub/scheduled-actions/{id}` | Update scheduled action ## create-deploy -Create a Deploy +Create a deploy This API performs a deploy based on an existing daft. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-deploy) @@ -290,7 +290,7 @@ func main() { [[Back to top]](#) ## create-scheduled-action -Create Scheduled Action +Create scheduled action This API creates a new scheduled action for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-scheduled-action) @@ -379,7 +379,7 @@ func main() { [[Back to top]](#) ## create-uploaded-configuration -Upload a Configuration +Upload a configuration This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. @@ -447,7 +447,7 @@ func main() { [[Back to top]](#) ## delete-backup -Delete a Backup +Delete a backup This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. @@ -656,7 +656,7 @@ func main() { [[Back to top]](#) ## delete-scheduled-action -Delete Scheduled Action +Delete scheduled action This API deletes an existing scheduled action. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-scheduled-action) @@ -721,7 +721,7 @@ func main() { [[Back to top]](#) ## delete-uploaded-configuration -Delete an Uploaded Configuration +Delete an uploaded configuration This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. @@ -790,7 +790,7 @@ func main() { [[Back to top]](#) ## get-deploy -Get a Deploy +Get a deploy This API gets an existing deploy for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-deploy) @@ -925,7 +925,7 @@ func main() { [[Back to top]](#) ## get-uploaded-configuration -Get an Uploaded Configuration +Get an uploaded configuration This API gets an existing uploaded configuration for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-uploaded-configuration) @@ -991,7 +991,7 @@ func main() { [[Back to top]](#) ## list-backups -List Backups +List backups This API gets a list of existing backups for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-backups) @@ -1053,7 +1053,7 @@ func main() { [[Back to top]](#) ## list-deploys -List Deploys +List deploys This API gets a list of deploys for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-deploys) @@ -1110,7 +1110,7 @@ func main() { [[Back to top]](#) ## list-drafts -List Drafts +List drafts This API gets a list of existing drafts for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-drafts) @@ -1172,7 +1172,7 @@ func main() { [[Back to top]](#) ## list-scheduled-actions -List Scheduled Actions +List scheduled actions This API gets a list of existing scheduled actions for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-scheduled-actions) @@ -1229,7 +1229,7 @@ func main() { [[Back to top]](#) ## list-uploaded-configurations -List Uploaded Configurations +List uploaded configurations This API gets a list of existing uploaded configurations for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-uploaded-configurations) @@ -1380,7 +1380,7 @@ func main() { [[Back to top]](#) ## update-scheduled-action -Update Scheduled Action +Update scheduled action This API updates an existing scheduled action using JSON Patch format. [API Spec](https://developer.sailpoint.com/docs/api/v2024/update-scheduled-action) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorCustomizersAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorCustomizersAPI.md index ce925084a..a9cd21cec 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorCustomizersAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorCustomizersAPI.md @@ -18,16 +18,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-connector-customizer**](#create-connector-customizer) | **Post** `/connector-customizers` | Create Connector Customizer +[**create-connector-customizer**](#create-connector-customizer) | **Post** `/connector-customizers` | Create connector customizer [**create-connector-customizer-version**](#create-connector-customizer-version) | **Post** `/connector-customizers/{id}/versions` | Creates a connector customizer version -[**delete-connector-customizer**](#delete-connector-customizer) | **Delete** `/connector-customizers/{id}` | Delete Connector Customizer +[**delete-connector-customizer**](#delete-connector-customizer) | **Delete** `/connector-customizers/{id}` | Delete connector customizer [**get-connector-customizer**](#get-connector-customizer) | **Get** `/connector-customizers/{id}` | Get connector customizer -[**list-connector-customizers**](#list-connector-customizers) | **Get** `/connector-customizers` | List All Connector Customizers -[**put-connector-customizer**](#put-connector-customizer) | **Put** `/connector-customizers/{id}` | Update Connector Customizer +[**list-connector-customizers**](#list-connector-customizers) | **Get** `/connector-customizers` | List all connector customizers +[**put-connector-customizer**](#put-connector-customizer) | **Put** `/connector-customizers/{id}` | Update connector customizer ## create-connector-customizer -Create Connector Customizer +Create connector customizer Create a connector customizer. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-connector-customizer) @@ -162,7 +162,7 @@ func main() { [[Back to top]](#) ## delete-connector-customizer -Delete Connector Customizer +Delete connector customizer Delete the connector customizer for the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-connector-customizer) @@ -293,7 +293,7 @@ func main() { [[Back to top]](#) ## list-connector-customizers -List All Connector Customizers +List all connector customizers List all connector customizers. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-connector-customizers) @@ -357,7 +357,7 @@ func main() { [[Back to top]](#) ## put-connector-customizer -Update Connector Customizer +Update connector customizer Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-customizer) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorRuleManagementAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorRuleManagementAPI.md index e79791084..cb4ece50a 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorRuleManagementAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorRuleManagementAPI.md @@ -22,16 +22,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-connector-rule**](#create-connector-rule) | **Post** `/connector-rules` | Create Connector Rule -[**delete-connector-rule**](#delete-connector-rule) | **Delete** `/connector-rules/{id}` | Delete Connector Rule -[**get-connector-rule**](#get-connector-rule) | **Get** `/connector-rules/{id}` | Get Connector Rule -[**get-connector-rule-list**](#get-connector-rule-list) | **Get** `/connector-rules` | List Connector Rules -[**put-connector-rule**](#put-connector-rule) | **Put** `/connector-rules/{id}` | Update Connector Rule -[**test-connector-rule**](#test-connector-rule) | **Post** `/connector-rules/validate` | Validate Connector Rule +[**create-connector-rule**](#create-connector-rule) | **Post** `/connector-rules` | Create connector rule +[**delete-connector-rule**](#delete-connector-rule) | **Delete** `/connector-rules/{id}` | Delete connector rule +[**get-connector-rule**](#get-connector-rule) | **Get** `/connector-rules/{id}` | Get connector rule +[**get-connector-rule-list**](#get-connector-rule-list) | **Get** `/connector-rules` | List connector rules +[**put-connector-rule**](#put-connector-rule) | **Put** `/connector-rules/{id}` | Update connector rule +[**test-connector-rule**](#test-connector-rule) | **Post** `/connector-rules/validate` | Validate connector rule ## create-connector-rule -Create Connector Rule +Create connector rule Create a connector rule from the available types. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-connector-rule) @@ -123,7 +123,7 @@ func main() { [[Back to top]](#) ## delete-connector-rule -Delete Connector Rule +Delete connector rule Delete the connector rule for the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-connector-rule) @@ -188,7 +188,7 @@ func main() { [[Back to top]](#) ## get-connector-rule -Get Connector Rule +Get connector rule Get a connector rule by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-rule) @@ -254,7 +254,7 @@ func main() { [[Back to top]](#) ## get-connector-rule-list -List Connector Rules +List connector rules List existing connector rules. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-rule-list) @@ -320,7 +320,7 @@ func main() { [[Back to top]](#) ## put-connector-rule -Update Connector Rule +Update connector rule Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-rule) @@ -414,7 +414,7 @@ func main() { [[Back to top]](#) ## test-connector-rule -Validate Connector Rule +Validate connector rule Detect issues within the connector rule's code to fix and list them. [API Spec](https://developer.sailpoint.com/docs/api/v2024/test-connector-rule) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorsAPI.md index 8eaa06fa8..9316eaa18 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorsAPI.md @@ -29,23 +29,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-custom-connector**](#create-custom-connector) | **Post** `/connectors` | Create Custom Connector -[**delete-custom-connector**](#delete-custom-connector) | **Delete** `/connectors/{scriptName}` | Delete Connector by Script Name -[**get-connector**](#get-connector) | **Get** `/connectors/{scriptName}` | Get Connector by Script Name -[**get-connector-correlation-config**](#get-connector-correlation-config) | **Get** `/connectors/{scriptName}/correlation-config` | Get Connector Correlation Configuration -[**get-connector-list**](#get-connector-list) | **Get** `/connectors` | Get Connector List -[**get-connector-source-config**](#get-connector-source-config) | **Get** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration -[**get-connector-source-template**](#get-connector-source-template) | **Get** `/connectors/{scriptName}/source-template` | Get Connector Source Template -[**get-connector-translations**](#get-connector-translations) | **Get** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations -[**put-connector-correlation-config**](#put-connector-correlation-config) | **Put** `/connectors/{scriptName}/correlation-config` | Update Connector Correlation Configuration -[**put-connector-source-config**](#put-connector-source-config) | **Put** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration -[**put-connector-source-template**](#put-connector-source-template) | **Put** `/connectors/{scriptName}/source-template` | Update Connector Source Template -[**put-connector-translations**](#put-connector-translations) | **Put** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations -[**update-connector**](#update-connector) | **Patch** `/connectors/{scriptName}` | Update Connector by Script Name +[**create-custom-connector**](#create-custom-connector) | **Post** `/connectors` | Create custom connector +[**delete-custom-connector**](#delete-custom-connector) | **Delete** `/connectors/{scriptName}` | Delete connector by script name +[**get-connector**](#get-connector) | **Get** `/connectors/{scriptName}` | Get connector by script name +[**get-connector-correlation-config**](#get-connector-correlation-config) | **Get** `/connectors/{scriptName}/correlation-config` | Get connector correlation configuration +[**get-connector-list**](#get-connector-list) | **Get** `/connectors` | Get connector list +[**get-connector-source-config**](#get-connector-source-config) | **Get** `/connectors/{scriptName}/source-config` | Get connector source configuration +[**get-connector-source-template**](#get-connector-source-template) | **Get** `/connectors/{scriptName}/source-template` | Get connector source template +[**get-connector-translations**](#get-connector-translations) | **Get** `/connectors/{scriptName}/translations/{locale}` | Get connector translations +[**put-connector-correlation-config**](#put-connector-correlation-config) | **Put** `/connectors/{scriptName}/correlation-config` | Update connector correlation configuration +[**put-connector-source-config**](#put-connector-source-config) | **Put** `/connectors/{scriptName}/source-config` | Update connector source configuration +[**put-connector-source-template**](#put-connector-source-template) | **Put** `/connectors/{scriptName}/source-template` | Update connector source template +[**put-connector-translations**](#put-connector-translations) | **Put** `/connectors/{scriptName}/translations/{locale}` | Update connector translations +[**update-connector**](#update-connector) | **Patch** `/connectors/{scriptName}` | Update connector by script name ## create-custom-connector -Create Custom Connector +Create custom connector Create custom connector. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-connector) @@ -118,7 +118,7 @@ func main() { [[Back to top]](#) ## delete-custom-connector -Delete Connector by Script Name +Delete connector by script name Delete a custom connector that using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-custom-connector) @@ -183,7 +183,7 @@ func main() { [[Back to top]](#) ## get-connector -Get Connector by Script Name +Get connector by script name Fetches a connector that using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector) @@ -251,7 +251,7 @@ func main() { [[Back to top]](#) ## get-connector-correlation-config -Get Connector Correlation Configuration +Get connector correlation configuration Fetches a connector's correlation config using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-correlation-config) @@ -317,7 +317,7 @@ func main() { [[Back to top]](#) ## get-connector-list -Get Connector List +Get connector list Fetches list of connectors that have 'RELEASED' status using filtering and pagination. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-list) @@ -387,7 +387,7 @@ func main() { [[Back to top]](#) ## get-connector-source-config -Get Connector Source Configuration +Get connector source configuration Fetches a connector's source config using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-source-config) @@ -453,7 +453,7 @@ func main() { [[Back to top]](#) ## get-connector-source-template -Get Connector Source Template +Get connector source template Fetches a connector's source template using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-source-template) @@ -519,7 +519,7 @@ func main() { [[Back to top]](#) ## get-connector-translations -Get Connector Translations +Get connector translations Fetches a connector's translations using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-translations) @@ -588,7 +588,7 @@ func main() { [[Back to top]](#) ## put-connector-correlation-config -Update Connector Correlation Configuration +Update connector correlation configuration Update a connector's correlation config using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-correlation-config) @@ -656,7 +656,7 @@ func main() { [[Back to top]](#) ## put-connector-source-config -Update Connector Source Configuration +Update connector source configuration Update a connector's source config using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-source-config) @@ -724,7 +724,7 @@ func main() { [[Back to top]](#) ## put-connector-source-template -Update Connector Source Template +Update connector source template Update a connector's source template using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-source-template) @@ -792,7 +792,7 @@ func main() { [[Back to top]](#) ## put-connector-translations -Update Connector Translations +Update connector translations Update a connector's translations using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-translations) @@ -861,7 +861,7 @@ func main() { [[Back to top]](#) ## update-connector -Update Connector by Script Name +Update connector by script name This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/CustomFormsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/CustomFormsAPI.md index 786d46ab4..9e36a19ed 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/CustomFormsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/CustomFormsAPI.md @@ -24,15 +24,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-form-definition**](#create-form-definition) | **Post** `/form-definitions` | Creates a form definition. -[**create-form-definition-dynamic-schema**](#create-form-definition-dynamic-schema) | **Post** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically. +[**create-form-definition-dynamic-schema**](#create-form-definition-dynamic-schema) | **Post** `/form-definitions/forms-action-dynamic-schema` | Generate json schema dynamically. [**create-form-definition-file-request**](#create-form-definition-file-request) | **Post** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file. [**create-form-instance**](#create-form-instance) | **Post** `/form-instances` | Creates a form instance. [**delete-form-definition**](#delete-form-definition) | **Delete** `/form-definitions/{formDefinitionID}` | Deletes a form definition. [**export-form-definitions-by-tenant**](#export-form-definitions-by-tenant) | **Get** `/form-definitions/export` | List form definitions by tenant. -[**get-file-from-s3**](#get-file-from-s3) | **Get** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId. +[**get-file-from-s3**](#get-file-from-s3) | **Get** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileid. [**get-form-definition-by-key**](#get-form-definition-by-key) | **Get** `/form-definitions/{formDefinitionID}` | Return a form definition. [**get-form-instance-by-key**](#get-form-instance-by-key) | **Get** `/form-instances/{formInstanceID}` | Returns a form instance. -[**get-form-instance-file**](#get-form-instance-file) | **Get** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId. +[**get-form-instance-file**](#get-form-instance-file) | **Get** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileid. [**import-form-definitions**](#import-form-definitions) | **Post** `/form-definitions/import` | Import form definitions from export. [**patch-form-definition**](#patch-form-definition) | **Patch** `/form-definitions/{formDefinitionID}` | Patch a form definition. [**patch-form-instance**](#patch-form-instance) | **Patch** `/form-instances/{formInstanceID}` | Patch a form instance. @@ -216,7 +216,7 @@ func main() { [[Back to top]](#) ## create-form-definition-dynamic-schema -Generate JSON Schema dynamically. +Generate json schema dynamically. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-dynamic-schema) @@ -570,7 +570,7 @@ func main() { [[Back to top]](#) ## get-file-from-s3 -Download definition file by fileId. +Download definition file by fileid. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-file-from-s3) @@ -771,7 +771,7 @@ func main() { [[Back to top]](#) ## get-form-instance-file -Download instance file by fileId. +Download instance file by fileid. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-file) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/CustomPasswordInstructionsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/CustomPasswordInstructionsAPI.md index 53a0c5548..f5a76dbb0 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/CustomPasswordInstructionsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/CustomPasswordInstructionsAPI.md @@ -26,9 +26,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-custom-password-instructions**](#create-custom-password-instructions) | **Post** `/custom-password-instructions` | Create Custom Password Instructions -[**delete-custom-password-instructions**](#delete-custom-password-instructions) | **Delete** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID -[**get-custom-password-instructions**](#get-custom-password-instructions) | **Get** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID +[**create-custom-password-instructions**](#create-custom-password-instructions) | **Post** `/custom-password-instructions` | Create custom password instructions +[**delete-custom-password-instructions**](#delete-custom-password-instructions) | **Delete** `/custom-password-instructions/{pageId}` | Delete custom password instructions by page id +[**get-custom-password-instructions**](#get-custom-password-instructions) | **Get** `/custom-password-instructions/{pageId}` | Get custom password instructions by page id ## create-custom-password-instructions @@ -43,7 +43,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create Custom Password Instructions +Create custom password instructions This API creates the custom password instructions for the specified page ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-password-instructions) @@ -127,7 +127,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Custom Password Instructions by page ID +Delete custom password instructions by page id This API delete the custom password instructions for the specified page ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-custom-password-instructions) @@ -207,7 +207,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Custom Password Instructions by Page ID +Get custom password instructions by page id This API returns the custom password instructions for the specified page ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-custom-password-instructions) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/DataSegmentationAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/DataSegmentationAPI.md index c2c1df9b1..39170fc3e 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/DataSegmentationAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/DataSegmentationAPI.md @@ -17,18 +17,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-data-segment**](#create-data-segment) | **Post** `/data-segments` | Create Segment -[**delete-data-segment**](#delete-data-segment) | **Delete** `/data-segments/{segmentId}` | Delete Segment by ID -[**get-data-segment**](#get-data-segment) | **Get** `/data-segments/{segmentId}` | Get Segment by ID -[**get-data-segment-identity-membership**](#get-data-segment-identity-membership) | **Get** `/data-segments/membership/{identityId}` | Get SegmentMembership by Identity ID -[**get-data-segmentation-enabled-for-user**](#get-data-segmentation-enabled-for-user) | **Get** `/data-segments/user-enabled/{identityId}` | Is Segmentation enabled by Identity -[**list-data-segments**](#list-data-segments) | **Get** `/data-segments` | Get Segments -[**patch-data-segment**](#patch-data-segment) | **Patch** `/data-segments/{segmentId}` | Update Segment -[**publish-data-segment**](#publish-data-segment) | **Post** `/data-segments/{segmentId}` | Publish segment by ID +[**create-data-segment**](#create-data-segment) | **Post** `/data-segments` | Create segment +[**delete-data-segment**](#delete-data-segment) | **Delete** `/data-segments/{segmentId}` | Delete segment by id +[**get-data-segment**](#get-data-segment) | **Get** `/data-segments/{segmentId}` | Get segment by id +[**get-data-segment-identity-membership**](#get-data-segment-identity-membership) | **Get** `/data-segments/membership/{identityId}` | Get segmentmembership by identity id +[**get-data-segmentation-enabled-for-user**](#get-data-segmentation-enabled-for-user) | **Get** `/data-segments/user-enabled/{identityId}` | Is segmentation enabled by identity +[**list-data-segments**](#list-data-segments) | **Get** `/data-segments` | Get segments +[**patch-data-segment**](#patch-data-segment) | **Patch** `/data-segments/{segmentId}` | Update segment +[**publish-data-segment**](#publish-data-segment) | **Post** `/data-segments/{segmentId}` | Publish segment by id ## create-data-segment -Create Segment +Create segment This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. @@ -107,7 +107,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Segment by ID +Delete segment by id This API deletes the segment specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-data-segment) @@ -187,7 +187,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Segment by ID +Get segment by id This API returns the segment specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segment) @@ -266,7 +266,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get SegmentMembership by Identity ID +Get segmentmembership by identity id This API returns the segment membership specified by the given identity ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segment-identity-membership) @@ -345,7 +345,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Is Segmentation enabled by Identity +Is segmentation enabled by identity This API returns whether or not segmentation is enabled for the identity. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segmentation-enabled-for-user) @@ -424,7 +424,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Segments +Get segments This API returns the segment specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-data-segments) @@ -511,7 +511,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Segment +Update segment Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-data-segment) @@ -597,7 +597,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Publish segment by ID +Publish segment by id This will publish the segment so that it starts applying the segmentation to the desired users if enabled [API Spec](https://developer.sailpoint.com/docs/api/v2024/publish-data-segment) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/DimensionsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/DimensionsAPI.md index 99448558b..36061043b 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/DimensionsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/DimensionsAPI.md @@ -16,18 +16,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-dimension**](#create-dimension) | **Post** `/roles/{roleId}/dimensions` | Create a Dimension -[**delete-bulk-dimensions**](#delete-bulk-dimensions) | **Post** `/roles/{roleId}/dimensions/bulk-delete` | Delete Dimension(s) -[**delete-dimension**](#delete-dimension) | **Delete** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a Dimension -[**get-dimension**](#get-dimension) | **Get** `/roles/{roleId}/dimensions/{dimensionId}` | Get a Dimension under Role. -[**get-dimension-entitlements**](#get-dimension-entitlements) | **Get** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List Dimension's Entitlements -[**list-dimension-access-profiles**](#list-dimension-access-profiles) | **Get** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List Dimension's Access Profiles -[**list-dimensions**](#list-dimensions) | **Get** `/roles/{roleId}/dimensions` | List Dimensions -[**patch-dimension**](#patch-dimension) | **Patch** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified Dimension +[**create-dimension**](#create-dimension) | **Post** `/roles/{roleId}/dimensions` | Create a dimension +[**delete-bulk-dimensions**](#delete-bulk-dimensions) | **Post** `/roles/{roleId}/dimensions/bulk-delete` | Delete dimension(s) +[**delete-dimension**](#delete-dimension) | **Delete** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a dimension +[**get-dimension**](#get-dimension) | **Get** `/roles/{roleId}/dimensions/{dimensionId}` | Get a dimension under role. +[**get-dimension-entitlements**](#get-dimension-entitlements) | **Get** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List dimension's entitlements +[**list-dimension-access-profiles**](#list-dimension-access-profiles) | **Get** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List dimension's access profiles +[**list-dimensions**](#list-dimensions) | **Get** `/roles/{roleId}/dimensions` | List dimensions +[**patch-dimension**](#patch-dimension) | **Patch** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified dimension ## create-dimension -Create a Dimension +Create a dimension This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. @@ -189,7 +189,7 @@ func main() { [[Back to top]](#) ## delete-bulk-dimensions -Delete Dimension(s) +Delete dimension(s) This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. @@ -267,7 +267,7 @@ func main() { [[Back to top]](#) ## delete-dimension -Delete a Dimension +Delete a dimension This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. @@ -336,7 +336,7 @@ func main() { [[Back to top]](#) ## get-dimension -Get a Dimension under Role. +Get a dimension under role. This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. @@ -407,7 +407,7 @@ func main() { [[Back to top]](#) ## get-dimension-entitlements -List Dimension's Entitlements +List dimension's entitlements This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. @@ -488,7 +488,7 @@ func main() { [[Back to top]](#) ## list-dimension-access-profiles -List Dimension's Access Profiles +List dimension's access profiles This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. @@ -569,7 +569,7 @@ func main() { [[Back to top]](#) ## list-dimensions -List Dimensions +List dimensions This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. @@ -649,7 +649,7 @@ func main() { [[Back to top]](#) ## patch-dimension -Patch a specified Dimension +Patch a specified dimension This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/EntitlementsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/EntitlementsAPI.md index 6457190b9..8e96f261a 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/EntitlementsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/EntitlementsAPI.md @@ -67,14 +67,14 @@ Method | HTTP request | Description [**create-access-model-metadata-for-entitlement**](#create-access-model-metadata-for-entitlement) | **Post** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. [**delete-access-model-metadata-from-entitlement**](#delete-access-model-metadata-from-entitlement) | **Delete** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. [**get-entitlement**](#get-entitlement) | **Get** `/entitlements/{id}` | Get an entitlement -[**get-entitlement-request-config**](#get-entitlement-request-config) | **Get** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config -[**import-entitlements-by-source**](#import-entitlements-by-source) | **Post** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements +[**get-entitlement-request-config**](#get-entitlement-request-config) | **Get** `/entitlements/{id}/entitlement-request-config` | Get entitlement request config +[**import-entitlements-by-source**](#import-entitlements-by-source) | **Post** `/entitlements/aggregate/sources/{id}` | Aggregate entitlements [**list-entitlement-children**](#list-entitlement-children) | **Get** `/entitlements/{id}/children` | List of entitlements children [**list-entitlement-parents**](#list-entitlement-parents) | **Get** `/entitlements/{id}/parents` | List of entitlements parents [**list-entitlements**](#list-entitlements) | **Get** `/entitlements` | Gets a list of entitlements. [**patch-entitlement**](#patch-entitlement) | **Patch** `/entitlements/{id}` | Patch an entitlement -[**put-entitlement-request-config**](#put-entitlement-request-config) | **Put** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config -[**reset-source-entitlements**](#reset-source-entitlements) | **Post** `/entitlements/reset/sources/{id}` | Reset Source Entitlements +[**put-entitlement-request-config**](#put-entitlement-request-config) | **Put** `/entitlements/{id}/entitlement-request-config` | Replace entitlement request config +[**reset-source-entitlements**](#reset-source-entitlements) | **Post** `/entitlements/reset/sources/{id}` | Reset source entitlements [**update-entitlements-in-bulk**](#update-entitlements-in-bulk) | **Post** `/entitlements/bulk-update` | Bulk update an entitlement list @@ -338,7 +338,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Entitlement Request Config +Get entitlement request config This API returns the entitlement request config for a specified entitlement. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-request-config) @@ -420,7 +420,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Aggregate Entitlements +Aggregate entitlements Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. @@ -863,7 +863,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Replace Entitlement Request Config +Replace entitlement request config This API replaces the entitlement request config for a specified entitlement. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-entitlement-request-config) @@ -971,7 +971,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Reset Source Entitlements +Reset source entitlements Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/GlobalTenantSecuritySettingsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/GlobalTenantSecuritySettingsAPI.md index eb96171ad..ae01fcde3 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/GlobalTenantSecuritySettingsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/GlobalTenantSecuritySettingsAPI.md @@ -19,14 +19,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-auth-org-network-config**](#create-auth-org-network-config) | **Post** `/auth-org/network-config` | Create security network configuration. -[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **Get** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. +[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **Get** `/auth-org/lockout-config` | Get auth org lockout configuration. [**get-auth-org-network-config**](#get-auth-org-network-config) | **Get** `/auth-org/network-config` | Get security network configuration. -[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **Get** `/auth-org/service-provider-config` | Get Service Provider Configuration. -[**get-auth-org-session-config**](#get-auth-org-session-config) | **Get** `/auth-org/session-config` | Get Auth Org Session Configuration. -[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **Patch** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration +[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **Get** `/auth-org/service-provider-config` | Get service provider configuration. +[**get-auth-org-session-config**](#get-auth-org-session-config) | **Get** `/auth-org/session-config` | Get auth org session configuration. +[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **Patch** `/auth-org/lockout-config` | Update auth org lockout configuration [**patch-auth-org-network-config**](#patch-auth-org-network-config) | **Patch** `/auth-org/network-config` | Update security network configuration. -[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **Patch** `/auth-org/service-provider-config` | Update Service Provider Configuration -[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **Patch** `/auth-org/session-config` | Update Auth Org Session Configuration +[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **Patch** `/auth-org/service-provider-config` | Update service provider configuration +[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **Patch** `/auth-org/session-config` | Update auth org session configuration ## create-auth-org-network-config @@ -101,7 +101,7 @@ func main() { [[Back to top]](#) ## get-auth-org-lockout-config -Get Auth Org Lockout Configuration. +Get auth org lockout configuration. This API returns the details of an org's lockout auth configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-lockout-config) @@ -215,7 +215,7 @@ func main() { [[Back to top]](#) ## get-auth-org-service-provider-config -Get Service Provider Configuration. +Get service provider configuration. This API returns the details of an org's service provider auth configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-service-provider-config) @@ -272,7 +272,7 @@ func main() { [[Back to top]](#) ## get-auth-org-session-config -Get Auth Org Session Configuration. +Get auth org session configuration. This API returns the details of an org's session auth configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-session-config) @@ -329,7 +329,7 @@ func main() { [[Back to top]](#) ## patch-auth-org-lockout-config -Update Auth Org Lockout Configuration +Update auth org lockout configuration This API updates an existing lockout configuration for an org using PATCH @@ -465,7 +465,7 @@ func main() { [[Back to top]](#) ## patch-auth-org-service-provider-config -Update Service Provider Configuration +Update service provider configuration This API updates an existing service provider configuration for an org using PATCH. [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-service-provider-config) @@ -532,7 +532,7 @@ func main() { [[Back to top]](#) ## patch-auth-org-session-config -Update Auth Org Session Configuration +Update auth org session configuration This API updates an existing session configuration for an org using PATCH. [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-session-config) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/GovernanceGroupsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/GovernanceGroupsAPI.md index c0793f69b..bb11e2368 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/GovernanceGroupsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/GovernanceGroupsAPI.md @@ -20,16 +20,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-workgroup**](#create-workgroup) | **Post** `/workgroups` | Create a new Governance Group. -[**delete-workgroup**](#delete-workgroup) | **Delete** `/workgroups/{id}` | Delete a Governance Group -[**delete-workgroup-members**](#delete-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group -[**delete-workgroups-in-bulk**](#delete-workgroups-in-bulk) | **Post** `/workgroups/bulk-delete` | Delete Governance Group(s) -[**get-workgroup**](#get-workgroup) | **Get** `/workgroups/{id}` | Get Governance Group by Id -[**list-connections**](#list-connections) | **Get** `/workgroups/{workgroupId}/connections` | List connections for Governance Group -[**list-workgroup-members**](#list-workgroup-members) | **Get** `/workgroups/{workgroupId}/members` | List Governance Group Members -[**list-workgroups**](#list-workgroups) | **Get** `/workgroups` | List Governance Groups -[**patch-workgroup**](#patch-workgroup) | **Patch** `/workgroups/{id}` | Patch a Governance Group -[**update-workgroup-members**](#update-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group +[**create-workgroup**](#create-workgroup) | **Post** `/workgroups` | Create a new governance group. +[**delete-workgroup**](#delete-workgroup) | **Delete** `/workgroups/{id}` | Delete a governance group +[**delete-workgroup-members**](#delete-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from governance group +[**delete-workgroups-in-bulk**](#delete-workgroups-in-bulk) | **Post** `/workgroups/bulk-delete` | Delete governance group(s) +[**get-workgroup**](#get-workgroup) | **Get** `/workgroups/{id}` | Get governance group by id +[**list-connections**](#list-connections) | **Get** `/workgroups/{workgroupId}/connections` | List connections for governance group +[**list-workgroup-members**](#list-workgroup-members) | **Get** `/workgroups/{workgroupId}/members` | List governance group members +[**list-workgroups**](#list-workgroups) | **Get** `/workgroups` | List governance groups +[**patch-workgroup**](#patch-workgroup) | **Patch** `/workgroups/{id}` | Patch a governance group +[**update-workgroup-members**](#update-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-add` | Add members to governance group ## create-workgroup @@ -44,7 +44,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create a new Governance Group. +Create a new governance group. This API creates a new Governance Group. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workgroup) @@ -139,7 +139,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete a Governance Group +Delete a governance group This API deletes a Governance Group by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroup) @@ -217,7 +217,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Remove members from Governance Group +Remove members from governance group This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** @@ -306,7 +306,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Governance Group(s) +Delete governance group(s) This API initiates a bulk deletion of one or more Governance Groups. @@ -399,7 +399,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Governance Group by Id +Get governance group by id This API returns a Governance Groups by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workgroup) @@ -478,7 +478,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List connections for Governance Group +List connections for governance group This API returns list of connections associated with a Governance Group. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-connections) @@ -565,7 +565,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Governance Group Members +List governance group members This API returns list of members associated with a Governance Group. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workgroup-members) @@ -652,7 +652,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Governance Groups +List governance groups This API returns list of Governance Groups [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workgroups) @@ -735,7 +735,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch a Governance Group +Patch a governance group This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description @@ -819,7 +819,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Add members to Governance Group +Add members to governance group This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IAIAccessRequestRecommendationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IAIAccessRequestRecommendationsAPI.md index 20f398147..69f85672b 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/IAIAccessRequestRecommendationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IAIAccessRequestRecommendationsAPI.md @@ -15,16 +15,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **Post** `/ai-access-request-recommendations/ignored-items` | Ignore Access Request Recommendation -[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **Post** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation -[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **Post** `/ai-access-request-recommendations/viewed-items` | Mark Viewed Access Request Recommendations -[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **Post** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk Mark Viewed Access Request Recommendations -[**get-access-request-recommendations**](#get-access-request-recommendations) | **Get** `/ai-access-request-recommendations` | Identity Access Request Recommendations -[**get-access-request-recommendations-config**](#get-access-request-recommendations-config) | **Get** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config -[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **Get** `/ai-access-request-recommendations/ignored-items` | List Ignored Access Request Recommendations -[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **Get** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations -[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **Get** `/ai-access-request-recommendations/viewed-items` | List Viewed Access Request Recommendations -[**set-access-request-recommendations-config**](#set-access-request-recommendations-config) | **Put** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config +[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **Post** `/ai-access-request-recommendations/ignored-items` | Ignore access request recommendation +[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **Post** `/ai-access-request-recommendations/requested-items` | Accept access request recommendation +[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **Post** `/ai-access-request-recommendations/viewed-items` | Mark viewed access request recommendations +[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **Post** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk mark viewed access request recommendations +[**get-access-request-recommendations**](#get-access-request-recommendations) | **Get** `/ai-access-request-recommendations` | Identity access request recommendations +[**get-access-request-recommendations-config**](#get-access-request-recommendations-config) | **Get** `/ai-access-request-recommendations/config` | Get access request recommendations config +[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **Get** `/ai-access-request-recommendations/ignored-items` | List ignored access request recommendations +[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **Get** `/ai-access-request-recommendations/requested-items` | List accepted access request recommendations +[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **Get** `/ai-access-request-recommendations/viewed-items` | List viewed access request recommendations +[**set-access-request-recommendations-config**](#set-access-request-recommendations-config) | **Put** `/ai-access-request-recommendations/config` | Update access request recommendations config ## add-access-request-recommendations-ignored-item @@ -39,7 +39,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Ignore Access Request Recommendation +Ignore access request recommendation This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-ignored-item) @@ -125,7 +125,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Accept Access Request Recommendation +Accept access request recommendation This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-requested-item) @@ -211,7 +211,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Mark Viewed Access Request Recommendations +Mark viewed access request recommendations This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-viewed-item) @@ -297,7 +297,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Bulk Mark Viewed Access Request Recommendations +Bulk mark viewed access request recommendations This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-viewed-items) @@ -377,7 +377,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Identity Access Request Recommendations +Identity access request recommendations This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations) @@ -464,7 +464,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Access Request Recommendations config +Get access request recommendations config This API returns the configurations for Access Request Recommender for the tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-config) @@ -537,7 +537,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Ignored Access Request Recommendations +List ignored access request recommendations This API returns the list of ignored access request recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-ignored-items) @@ -620,7 +620,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Accepted Access Request Recommendations +List accepted access request recommendations This API returns a list of requested access request recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-requested-items) @@ -703,7 +703,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Viewed Access Request Recommendations +List viewed access request recommendations This API returns the list of viewed access request recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-viewed-items) @@ -786,7 +786,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Access Request Recommendations config +Update access request recommendations config This API updates the configurations for Access Request Recommender for the tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-recommendations-config) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IAIOutliersAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IAIOutliersAPI.md index b7add5a1e..167cfb9f8 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/IAIOutliersAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IAIOutliersAPI.md @@ -15,15 +15,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**export-outliers-zip**](#export-outliers-zip) | **Get** `/outliers/export` | IAI Identity Outliers Export -[**get-identity-outlier-snapshots**](#get-identity-outlier-snapshots) | **Get** `/outlier-summaries` | IAI Identity Outliers Summary -[**get-identity-outliers**](#get-identity-outliers) | **Get** `/outliers` | IAI Get Identity Outliers -[**get-latest-identity-outlier-snapshots**](#get-latest-identity-outlier-snapshots) | **Get** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary +[**export-outliers-zip**](#export-outliers-zip) | **Get** `/outliers/export` | Iai identity outliers export +[**get-identity-outlier-snapshots**](#get-identity-outlier-snapshots) | **Get** `/outlier-summaries` | Iai identity outliers summary +[**get-identity-outliers**](#get-identity-outliers) | **Get** `/outliers` | Iai get identity outliers +[**get-latest-identity-outlier-snapshots**](#get-latest-identity-outlier-snapshots) | **Get** `/outlier-summaries/latest` | Iai identity outliers latest summary [**get-outlier-contributing-feature-summary**](#get-outlier-contributing-feature-summary) | **Get** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary [**get-peer-group-outliers-contributing-features**](#get-peer-group-outliers-contributing-features) | **Get** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features -[**ignore-identity-outliers**](#ignore-identity-outliers) | **Post** `/outliers/ignore` | IAI Identity Outliers Ignore +[**ignore-identity-outliers**](#ignore-identity-outliers) | **Post** `/outliers/ignore` | Iai identity outliers ignore [**list-outliers-contributing-feature-access-items**](#list-outliers-contributing-feature-access-items) | **Get** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature -[**un-ignore-identity-outliers**](#un-ignore-identity-outliers) | **Post** `/outliers/unignore` | IAI Identity Outliers Unignore +[**un-ignore-identity-outliers**](#un-ignore-identity-outliers) | **Post** `/outliers/unignore` | Iai identity outliers unignore ## export-outliers-zip @@ -38,7 +38,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -IAI Identity Outliers Export +Iai identity outliers export This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). @@ -116,7 +116,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -IAI Identity Outliers Summary +Iai identity outliers summary This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-outlier-snapshots) @@ -199,7 +199,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -IAI Get Identity Outliers +Iai get identity outliers This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-outliers) @@ -284,7 +284,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -IAI Identity Outliers Latest Summary +Iai identity outliers latest summary This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-latest-identity-outlier-snapshots) @@ -533,7 +533,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -IAI Identity Outliers Ignore +Iai identity outliers ignore This API receives a list of identity IDs in the request, changes the outliers to be ignored. [API Spec](https://developer.sailpoint.com/docs/api/v2024/ignore-identity-outliers) @@ -707,7 +707,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -IAI Identity Outliers Unignore +Iai identity outliers unignore This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. [API Spec](https://developer.sailpoint.com/docs/api/v2024/un-ignore-identity-outliers) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IAIPeerGroupStrategiesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IAIPeerGroupStrategiesAPI.md index 1bab0deca..90de065b9 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/IAIPeerGroupStrategiesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IAIPeerGroupStrategiesAPI.md @@ -15,7 +15,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-peer-group-outliers**](#get-peer-group-outliers) | **Get** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List +[**get-peer-group-outliers**](#get-peer-group-outliers) | **Get** `/peer-group-strategies/{strategy}/identity-outliers` | Identity outliers list ## get-peer-group-outliers @@ -33,7 +33,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Identity Outliers List +Identity outliers list -- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-peer-group-outliers) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IAIRecommendationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IAIRecommendationsAPI.md index 97e6f2c7b..b58b99c44 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/IAIRecommendationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IAIRecommendationsAPI.md @@ -15,7 +15,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-recommendations**](#get-recommendations) | **Post** `/recommendations/request` | Returns Recommendation Based on Object +[**get-recommendations**](#get-recommendations) | **Post** `/recommendations/request` | Returns recommendation based on object [**get-recommendations-config**](#get-recommendations-config) | **Get** `/recommendations/config` | Get certification recommendation config values [**update-recommendations-config**](#update-recommendations-config) | **Put** `/recommendations/config` | Update certification recommendation config values @@ -32,7 +32,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Returns Recommendation Based on Object +Returns recommendation based on object The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-recommendations) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IdentitiesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IdentitiesAPI.md index 4d615f421..2094edf74 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/IdentitiesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IdentitiesAPI.md @@ -31,15 +31,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**delete-identity**](#delete-identity) | **Delete** `/identities/{id}` | Delete identity -[**get-identity**](#get-identity) | **Get** `/identities/{id}` | Identity Details +[**get-identity**](#get-identity) | **Get** `/identities/{id}` | Identity details [**get-identity-ownership-details**](#get-identity-ownership-details) | **Get** `/identities/{identityId}/ownership` | Get ownership details [**get-role-assignment**](#get-role-assignment) | **Get** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details [**get-role-assignments**](#get-role-assignments) | **Get** `/identities/{identityId}/role-assignments` | List role assignments -[**list-identities**](#list-identities) | **Get** `/identities` | List Identities +[**list-identities**](#list-identities) | **Get** `/identities` | List identities [**reset-identity**](#reset-identity) | **Post** `/identities/{id}/reset` | Reset an identity [**send-identity-verification-account-token**](#send-identity-verification-account-token) | **Post** `/identities/{id}/verification/account/send` | Send password reset email [**start-identities-invite**](#start-identities-invite) | **Post** `/identities/invite` | Invite identities to register -[**start-identity-processing**](#start-identity-processing) | **Post** `/identities/process` | Process a list of identityIds +[**start-identity-processing**](#start-identity-processing) | **Post** `/identities/process` | Process a list of identityids [**synchronize-attributes-for-identity**](#synchronize-attributes-for-identity) | **Post** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. @@ -133,7 +133,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Identity Details +Identity details This API returns a single identity using the Identity ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity) @@ -458,7 +458,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Identities +List identities This API returns a list of identities. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identities) @@ -798,7 +798,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Process a list of identityIds +Process a list of identityids This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. This endpoint will perform the following tasks: diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IdentityAttributesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IdentityAttributesAPI.md index 0a51ed84d..8670861a8 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/IdentityAttributesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IdentityAttributesAPI.md @@ -15,12 +15,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-identity-attribute**](#create-identity-attribute) | **Post** `/identity-attributes` | Create Identity Attribute -[**delete-identity-attribute**](#delete-identity-attribute) | **Delete** `/identity-attributes/{name}` | Delete Identity Attribute -[**delete-identity-attributes-in-bulk**](#delete-identity-attributes-in-bulk) | **Delete** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes -[**get-identity-attribute**](#get-identity-attribute) | **Get** `/identity-attributes/{name}` | Get Identity Attribute -[**list-identity-attributes**](#list-identity-attributes) | **Get** `/identity-attributes` | List Identity Attributes -[**put-identity-attribute**](#put-identity-attribute) | **Put** `/identity-attributes/{name}` | Update Identity Attribute +[**create-identity-attribute**](#create-identity-attribute) | **Post** `/identity-attributes` | Create identity attribute +[**delete-identity-attribute**](#delete-identity-attribute) | **Delete** `/identity-attributes/{name}` | Delete identity attribute +[**delete-identity-attributes-in-bulk**](#delete-identity-attributes-in-bulk) | **Delete** `/identity-attributes/bulk-delete` | Bulk delete identity attributes +[**get-identity-attribute**](#get-identity-attribute) | **Get** `/identity-attributes/{name}` | Get identity attribute +[**list-identity-attributes**](#list-identity-attributes) | **Get** `/identity-attributes` | List identity attributes +[**put-identity-attribute**](#put-identity-attribute) | **Put** `/identity-attributes/{name}` | Update identity attribute ## create-identity-attribute @@ -35,7 +35,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create Identity Attribute +Create identity attribute Use this API to create a new identity attribute. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-attribute) @@ -136,7 +136,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Identity Attribute +Delete identity attribute This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attribute) @@ -214,7 +214,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Bulk delete Identity Attributes +Bulk delete identity attributes Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attributes-in-bulk) @@ -295,7 +295,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Identity Attribute +Get identity attribute This gets an identity attribute for a given technical name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-attribute) @@ -374,7 +374,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Identity Attributes +List identity attributes Use this API to get a collection of identity attributes. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-attributes) @@ -455,7 +455,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Identity Attribute +Update identity attribute This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-identity-attribute) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IdentityHistoryAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IdentityHistoryAPI.md index 763652ca1..dc1e7f235 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/IdentityHistoryAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IdentityHistoryAPI.md @@ -16,14 +16,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**compare-identity-snapshots**](#compare-identity-snapshots) | **Get** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots -[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **Get** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots +[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **Get** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accesstype for the given identity between 2 snapshots [**get-historical-identity**](#get-historical-identity) | **Get** `/historical-identities/{id}` | Get latest snapshot of identity [**get-historical-identity-events**](#get-historical-identity-events) | **Get** `/historical-identities/{id}/events` | Lists all events for the given identity [**get-identity-snapshot**](#get-identity-snapshot) | **Get** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date [**get-identity-snapshot-summary**](#get-identity-snapshot-summary) | **Get** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity [**get-identity-start-date**](#get-identity-start-date) | **Get** `/historical-identities/{id}/start-date` | Gets the start date of the identity [**list-historical-identities**](#list-historical-identities) | **Get** `/historical-identities` | Lists all the identities -[**list-identity-access-items**](#list-identity-access-items) | **Get** `/historical-identities/{id}/access-items` | List Access Items by Identity +[**list-identity-access-items**](#list-identity-access-items) | **Get** `/historical-identities/{id}/access-items` | List access items by identity [**list-identity-snapshot-access-items**](#list-identity-snapshot-access-items) | **Get** `/historical-identities/{id}/snapshots/{date}/access-items` | Gets the list of identity access items at a given date filterd by item type [**list-identity-snapshots**](#list-identity-snapshots) | **Get** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity @@ -131,7 +131,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Gets a list of differences of specific accessType for the given identity between 2 snapshots +Gets a list of differences of specific accesstype for the given identity between 2 snapshots This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' [API Spec](https://developer.sailpoint.com/docs/api/v2024/compare-identity-snapshots-access-type) @@ -730,7 +730,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Access Items by Identity +List access items by identity This method retrieves a list of access item for the identity filtered by the access item type diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IdentityProfilesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IdentityProfilesAPI.md index 291107afa..ff5a1ecf0 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/IdentityProfilesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IdentityProfilesAPI.md @@ -25,21 +25,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-identity-profile**](#create-identity-profile) | **Post** `/identity-profiles` | Create Identity Profile -[**delete-identity-profile**](#delete-identity-profile) | **Delete** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile -[**delete-identity-profiles**](#delete-identity-profiles) | **Post** `/identity-profiles/bulk-delete` | Delete Identity Profiles -[**export-identity-profiles**](#export-identity-profiles) | **Get** `/identity-profiles/export` | Export Identity Profiles -[**generate-identity-preview**](#generate-identity-preview) | **Post** `/identity-profiles/identity-preview` | Generate Identity Profile Preview -[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **Get** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config -[**get-identity-profile**](#get-identity-profile) | **Get** `/identity-profiles/{identity-profile-id}` | Get Identity Profile -[**import-identity-profiles**](#import-identity-profiles) | **Post** `/identity-profiles/import` | Import Identity Profiles -[**list-identity-profiles**](#list-identity-profiles) | **Get** `/identity-profiles` | List Identity Profiles +[**create-identity-profile**](#create-identity-profile) | **Post** `/identity-profiles` | Create identity profile +[**delete-identity-profile**](#delete-identity-profile) | **Delete** `/identity-profiles/{identity-profile-id}` | Delete identity profile +[**delete-identity-profiles**](#delete-identity-profiles) | **Post** `/identity-profiles/bulk-delete` | Delete identity profiles +[**export-identity-profiles**](#export-identity-profiles) | **Get** `/identity-profiles/export` | Export identity profiles +[**generate-identity-preview**](#generate-identity-preview) | **Post** `/identity-profiles/identity-preview` | Generate identity profile preview +[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **Get** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default identity attribute config +[**get-identity-profile**](#get-identity-profile) | **Get** `/identity-profiles/{identity-profile-id}` | Get identity profile +[**import-identity-profiles**](#import-identity-profiles) | **Post** `/identity-profiles/import` | Import identity profiles +[**list-identity-profiles**](#list-identity-profiles) | **Get** `/identity-profiles` | List identity profiles [**sync-identity-profile**](#sync-identity-profile) | **Post** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile -[**update-identity-profile**](#update-identity-profile) | **Patch** `/identity-profiles/{identity-profile-id}` | Update Identity Profile +[**update-identity-profile**](#update-identity-profile) | **Patch** `/identity-profiles/{identity-profile-id}` | Update identity profile ## create-identity-profile -Create Identity Profile +Create identity profile Creates an identity profile. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-profile) @@ -154,7 +154,7 @@ func main() { [[Back to top]](#) ## delete-identity-profile -Delete Identity Profile +Delete identity profile Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. @@ -221,7 +221,7 @@ func main() { [[Back to top]](#) ## delete-identity-profiles -Delete Identity Profiles +Delete identity profiles This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. @@ -292,7 +292,7 @@ func main() { [[Back to top]](#) ## export-identity-profiles -Export Identity Profiles +Export identity profiles This exports existing identity profiles in the format specified by the sp-config service. [API Spec](https://developer.sailpoint.com/docs/api/v2024/export-identity-profiles) @@ -373,7 +373,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Generate Identity Profile Preview +Generate identity profile preview This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied. [API Spec](https://developer.sailpoint.com/docs/api/v2024/generate-identity-preview) @@ -468,7 +468,7 @@ func main() { [[Back to top]](#) ## get-default-identity-attribute-config -Get default Identity Attribute Config +Get default identity attribute config This returns the default identity attribute config. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-default-identity-attribute-config) @@ -534,7 +534,7 @@ func main() { [[Back to top]](#) ## get-identity-profile -Get Identity Profile +Get identity profile Get a single identity profile by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-profile) @@ -600,7 +600,7 @@ func main() { [[Back to top]](#) ## import-identity-profiles -Import Identity Profiles +Import identity profiles This imports previously exported identity profiles. [API Spec](https://developer.sailpoint.com/docs/api/v2024/import-identity-profiles) @@ -667,7 +667,7 @@ func main() { [[Back to top]](#) ## list-identity-profiles -List Identity Profiles +List identity profiles Get a list of identity profiles, based on the specified query parameters. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-profiles) @@ -807,7 +807,7 @@ func main() { [[Back to top]](#) ## update-identity-profile -Update Identity Profile +Update identity profile Update a specified identity profile with this PATCH request. You cannot update these fields: diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/LifecycleStatesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/LifecycleStatesAPI.md index 6b920e1c4..f48772209 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/LifecycleStatesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/LifecycleStatesAPI.md @@ -53,16 +53,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-lifecycle-state**](#create-lifecycle-state) | **Post** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State -[**delete-lifecycle-state**](#delete-lifecycle-state) | **Delete** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State -[**get-lifecycle-state**](#get-lifecycle-state) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State -[**get-lifecycle-states**](#get-lifecycle-states) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates -[**set-lifecycle-state**](#set-lifecycle-state) | **Post** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State -[**update-lifecycle-states**](#update-lifecycle-states) | **Patch** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State +[**create-lifecycle-state**](#create-lifecycle-state) | **Post** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create lifecycle state +[**delete-lifecycle-state**](#delete-lifecycle-state) | **Delete** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete lifecycle state +[**get-lifecycle-state**](#get-lifecycle-state) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get lifecycle state +[**get-lifecycle-states**](#get-lifecycle-states) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists lifecyclestates +[**set-lifecycle-state**](#set-lifecycle-state) | **Post** `/identities/{identity-id}/set-lifecycle-state` | Set lifecycle state +[**update-lifecycle-states**](#update-lifecycle-states) | **Patch** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update lifecycle state ## create-lifecycle-state -Create Lifecycle State +Create lifecycle state Use this endpoint to create a lifecycle state. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-lifecycle-state) @@ -159,7 +159,7 @@ func main() { [[Back to top]](#) ## delete-lifecycle-state -Delete Lifecycle State +Delete lifecycle state Use this endpoint to delete the lifecycle state by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-lifecycle-state) @@ -228,7 +228,7 @@ func main() { [[Back to top]](#) ## get-lifecycle-state -Get Lifecycle State +Get lifecycle state Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-lifecycle-state) @@ -297,7 +297,7 @@ func main() { [[Back to top]](#) ## get-lifecycle-states -Lists LifecycleStates +Lists lifecyclestates Use this endpoint to list all lifecycle states by their associated identity profiles. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-lifecycle-states) @@ -371,7 +371,7 @@ func main() { [[Back to top]](#) ## set-lifecycle-state -Set Lifecycle State +Set lifecycle state Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. [API Spec](https://developer.sailpoint.com/docs/api/v2024/set-lifecycle-state) @@ -444,7 +444,7 @@ func main() { [[Back to top]](#) ## update-lifecycle-states -Update Lifecycle State +Update lifecycle state Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. [API Spec](https://developer.sailpoint.com/docs/api/v2024/update-lifecycle-states) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/MFAConfigurationAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/MFAConfigurationAPI.md index cab085808..dc922ecca 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/MFAConfigurationAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/MFAConfigurationAPI.md @@ -15,17 +15,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-mfa-duo-config**](#get-mfa-duo-config) | **Get** `/mfa/duo-web/config` | Configuration of Duo MFA method -[**get-mfa-kba-config**](#get-mfa-kba-config) | **Get** `/mfa/kba/config` | Configuration of KBA MFA method -[**get-mfa-okta-config**](#get-mfa-okta-config) | **Get** `/mfa/okta-verify/config` | Configuration of Okta MFA method -[**set-mfa-duo-config**](#set-mfa-duo-config) | **Put** `/mfa/duo-web/config` | Set Duo MFA configuration -[**set-mfakba-config**](#set-mfakba-config) | **Post** `/mfa/kba/config/answers` | Set MFA KBA configuration -[**set-mfa-okta-config**](#set-mfa-okta-config) | **Put** `/mfa/okta-verify/config` | Set Okta MFA configuration -[**test-mfa-config**](#test-mfa-config) | **Get** `/mfa/{method}/test` | MFA method's test configuration +[**get-mfa-duo-config**](#get-mfa-duo-config) | **Get** `/mfa/duo-web/config` | Configuration of duo mfa method +[**get-mfa-kba-config**](#get-mfa-kba-config) | **Get** `/mfa/kba/config` | Configuration of kba mfa method +[**get-mfa-okta-config**](#get-mfa-okta-config) | **Get** `/mfa/okta-verify/config` | Configuration of okta mfa method +[**set-mfa-duo-config**](#set-mfa-duo-config) | **Put** `/mfa/duo-web/config` | Set duo mfa configuration +[**set-mfakba-config**](#set-mfakba-config) | **Post** `/mfa/kba/config/answers` | Set mfa kba configuration +[**set-mfa-okta-config**](#set-mfa-okta-config) | **Put** `/mfa/okta-verify/config` | Set okta mfa configuration +[**test-mfa-config**](#test-mfa-config) | **Get** `/mfa/{method}/test` | Mfa method's test configuration ## get-mfa-duo-config -Configuration of Duo MFA method +Configuration of duo mfa method This API returns the configuration of an Duo MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-duo-config) @@ -82,7 +82,7 @@ func main() { [[Back to top]](#) ## get-mfa-kba-config -Configuration of KBA MFA method +Configuration of kba mfa method This API returns the KBA configuration for MFA. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-kba-config) @@ -144,7 +144,7 @@ func main() { [[Back to top]](#) ## get-mfa-okta-config -Configuration of Okta MFA method +Configuration of okta mfa method This API returns the configuration of an Okta MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-okta-config) @@ -201,7 +201,7 @@ func main() { [[Back to top]](#) ## set-mfa-duo-config -Set Duo MFA configuration +Set duo mfa configuration This API sets the configuration of an Duo MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfa-duo-config) @@ -278,7 +278,7 @@ func main() { [[Back to top]](#) ## set-mfakba-config -Set MFA KBA configuration +Set mfa kba configuration This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfakba-config) @@ -345,7 +345,7 @@ func main() { [[Back to top]](#) ## set-mfa-okta-config -Set Okta MFA configuration +Set okta mfa configuration This API sets the configuration of an Okta MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfa-okta-config) @@ -418,7 +418,7 @@ func main() { [[Back to top]](#) ## test-mfa-config -MFA method's test configuration +Mfa method's test configuration This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. [API Spec](https://developer.sailpoint.com/docs/api/v2024/test-mfa-config) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountMappingsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountMappingsAPI.md index 95ae9eb90..78dcb8268 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountMappingsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountMappingsAPI.md @@ -15,14 +15,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-machine-account-mappings**](#create-machine-account-mappings) | **Post** `/sources/{sourceId}/machine-account-mappings` | Create Machine Account Mappings -[**delete-machine-account-mappings**](#delete-machine-account-mappings) | **Delete** `/sources/{sourceId}/machine-account-mappings` | Delete Source's Machine Account Mappings -[**list-machine-account-mappings**](#list-machine-account-mappings) | **Get** `/sources/{sourceId}/machine-account-mappings` | Machine Account Mapping for Source -[**set-machine-account-mappings**](#set-machine-account-mappings) | **Put** `/sources/{sourceId}/machine-mappings` | Update Source's Machine Account Mappings +[**create-machine-account-mappings**](#create-machine-account-mappings) | **Post** `/sources/{sourceId}/machine-account-mappings` | Create machine account mappings +[**delete-machine-account-mappings**](#delete-machine-account-mappings) | **Delete** `/sources/{sourceId}/machine-account-mappings` | Delete source's machine account mappings +[**list-machine-account-mappings**](#list-machine-account-mappings) | **Get** `/sources/{sourceId}/machine-account-mappings` | Machine account mapping for source +[**set-machine-account-mappings**](#set-machine-account-mappings) | **Put** `/sources/{sourceId}/machine-mappings` | Update source's machine account mappings ## create-machine-account-mappings -Create Machine Account Mappings +Create machine account mappings Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. @@ -116,7 +116,7 @@ func main() { [[Back to top]](#) ## delete-machine-account-mappings -Delete Source's Machine Account Mappings +Delete source's machine account mappings Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. @@ -182,7 +182,7 @@ func main() { [[Back to top]](#) ## list-machine-account-mappings -Machine Account Mapping for Source +Machine account mapping for source Retrieves Machine account mappings for a specified source using Source ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-account-mappings) @@ -252,7 +252,7 @@ func main() { [[Back to top]](#) ## set-machine-account-mappings -Update Source's Machine Account Mappings +Update source's machine account mappings Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2024/set-machine-account-mappings) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountsAPI.md index 65d1661a9..87a0d82d0 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountsAPI.md @@ -15,9 +15,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-machine-account**](#get-machine-account) | **Get** `/machine-accounts/{id}` | Machine Account Details -[**list-machine-accounts**](#list-machine-accounts) | **Get** `/machine-accounts` | Machine Accounts List -[**update-machine-account**](#update-machine-account) | **Patch** `/machine-accounts/{id}` | Update a Machine Account +[**get-machine-account**](#get-machine-account) | **Get** `/machine-accounts/{id}` | Machine account details +[**list-machine-accounts**](#list-machine-accounts) | **Get** `/machine-accounts` | Machine accounts list +[**update-machine-account**](#update-machine-account) | **Patch** `/machine-accounts/{id}` | Update a machine account ## get-machine-account @@ -32,7 +32,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Machine Account Details +Machine account details Use this API to return the details for a single machine account by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-account) @@ -111,7 +111,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Machine Accounts List +Machine accounts list This returns a list of machine accounts. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-accounts) @@ -194,7 +194,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update a Machine Account +Update a machine account Use this API to update machine accounts details. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/MachineClassificationConfigAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/MachineClassificationConfigAPI.md index c8aa78cf1..de623cb06 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/MachineClassificationConfigAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/MachineClassificationConfigAPI.md @@ -15,13 +15,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**delete-machine-classification-config**](#delete-machine-classification-config) | **Delete** `/sources/{sourceId}/machine-classification-config` | Delete Source's Classification Config -[**get-machine-classification-config**](#get-machine-classification-config) | **Get** `/sources/{sourceId}/machine-classification-config` | Machine Classification Config for Source -[**set-machine-classification-config**](#set-machine-classification-config) | **Put** `/sources/{sourceId}/machine-classification-config` | Update Source's Classification Config +[**delete-machine-classification-config**](#delete-machine-classification-config) | **Delete** `/sources/{sourceId}/machine-classification-config` | Delete source's classification config +[**get-machine-classification-config**](#get-machine-classification-config) | **Get** `/sources/{sourceId}/machine-classification-config` | Machine classification config for source +[**set-machine-classification-config**](#set-machine-classification-config) | **Put** `/sources/{sourceId}/machine-classification-config` | Update source's classification config ## delete-machine-classification-config -Delete Source's Classification Config +Delete source's classification config Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. @@ -87,7 +87,7 @@ func main() { [[Back to top]](#) ## get-machine-classification-config -Machine Classification Config for Source +Machine classification config for source This API returns a Machine Classification Config for a Source using Source ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-classification-config) @@ -153,7 +153,7 @@ func main() { [[Back to top]](#) ## set-machine-classification-config -Update Source's Classification Config +Update source's classification config Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2024/set-machine-classification-config) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/MachineIdentitiesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/MachineIdentitiesAPI.md index f35543a06..11a507c4d 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/MachineIdentitiesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/MachineIdentitiesAPI.md @@ -15,11 +15,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-machine-identity**](#create-machine-identity) | **Post** `/machine-identities` | Create Machine Identities +[**create-machine-identity**](#create-machine-identity) | **Post** `/machine-identities` | Create machine identities [**delete-machine-identity**](#delete-machine-identity) | **Delete** `/machine-identities/{id}` | Delete machine identity -[**get-machine-identity**](#get-machine-identity) | **Get** `/machine-identities/{id}` | Machine Identity Details -[**list-machine-identities**](#list-machine-identities) | **Get** `/machine-identities` | List Machine Identities -[**update-machine-identity**](#update-machine-identity) | **Patch** `/machine-identities/{id}` | Update a Machine Identity +[**get-machine-identity**](#get-machine-identity) | **Get** `/machine-identities/{id}` | Machine identity details +[**list-machine-identities**](#list-machine-identities) | **Get** `/machine-identities` | List machine identities +[**update-machine-identity**](#update-machine-identity) | **Patch** `/machine-identities/{id}` | Update a machine identity ## create-machine-identity @@ -34,7 +34,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create Machine Identities +Create machine identities Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. @@ -202,7 +202,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Machine Identity Details +Machine identity details This API returns a single machine identity using the Machine Identity ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-identity) @@ -281,7 +281,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Machine Identities +List machine identities This API returns a list of machine identities. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-identities) @@ -364,7 +364,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update a Machine Identity +Update a machine identity Use this API to update machine identity details. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClientsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClientsAPI.md index f90f12c33..179708a7c 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClientsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClientsAPI.md @@ -17,16 +17,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-managed-client**](#create-managed-client) | **Post** `/managed-clients` | Create Managed Client -[**delete-managed-client**](#delete-managed-client) | **Delete** `/managed-clients/{id}` | Delete Managed Client -[**get-managed-client**](#get-managed-client) | **Get** `/managed-clients/{id}` | Get Managed Client -[**get-managed-client-status**](#get-managed-client-status) | **Get** `/managed-clients/{id}/status` | Get Managed Client Status -[**get-managed-clients**](#get-managed-clients) | **Get** `/managed-clients` | Get Managed Clients -[**update-managed-client**](#update-managed-client) | **Patch** `/managed-clients/{id}` | Update Managed Client +[**create-managed-client**](#create-managed-client) | **Post** `/managed-clients` | Create managed client +[**delete-managed-client**](#delete-managed-client) | **Delete** `/managed-clients/{id}` | Delete managed client +[**get-managed-client**](#get-managed-client) | **Get** `/managed-clients/{id}` | Get managed client +[**get-managed-client-status**](#get-managed-client-status) | **Get** `/managed-clients/{id}/status` | Get managed client status +[**get-managed-clients**](#get-managed-clients) | **Get** `/managed-clients` | Get managed clients +[**update-managed-client**](#update-managed-client) | **Patch** `/managed-clients/{id}` | Update managed client ## create-managed-client -Create Managed Client +Create managed client Create a new managed client. The API returns a result that includes the managed client ID. @@ -99,7 +99,7 @@ func main() { [[Back to top]](#) ## delete-managed-client -Delete Managed Client +Delete managed client Delete an existing managed client. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-client) @@ -164,7 +164,7 @@ func main() { [[Back to top]](#) ## get-managed-client -Get Managed Client +Get managed client Get managed client by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-client) @@ -230,7 +230,7 @@ func main() { [[Back to top]](#) ## get-managed-client-status -Get Managed Client Status +Get managed client status Get a managed client's status, using its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-client-status) @@ -298,7 +298,7 @@ func main() { [[Back to top]](#) ## get-managed-clients -Get Managed Clients +Get managed clients List managed clients. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-clients) @@ -366,7 +366,7 @@ func main() { [[Back to top]](#) ## update-managed-client -Update Managed Client +Update managed client Update an existing managed client. [API Spec](https://developer.sailpoint.com/docs/api/v2024/update-managed-client) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClusterTypesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClusterTypesAPI.md index f8efe7fbd..baa2e3d53 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClusterTypesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClusterTypesAPI.md @@ -17,15 +17,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-managed-cluster-type**](#create-managed-cluster-type) | **Post** `/managed-cluster-types` | Create new Managed Cluster Type -[**delete-managed-cluster-type**](#delete-managed-cluster-type) | **Delete** `/managed-cluster-types/{id}` | Delete a Managed Cluster Type -[**get-managed-cluster-type**](#get-managed-cluster-type) | **Get** `/managed-cluster-types/{id}` | Get a Managed Cluster Type -[**get-managed-cluster-types**](#get-managed-cluster-types) | **Get** `/managed-cluster-types` | Get Managed Cluster Types -[**update-managed-cluster-type**](#update-managed-cluster-type) | **Patch** `/managed-cluster-types/{id}` | Update a Managed Cluster Type +[**create-managed-cluster-type**](#create-managed-cluster-type) | **Post** `/managed-cluster-types` | Create new managed cluster type +[**delete-managed-cluster-type**](#delete-managed-cluster-type) | **Delete** `/managed-cluster-types/{id}` | Delete a managed cluster type +[**get-managed-cluster-type**](#get-managed-cluster-type) | **Get** `/managed-cluster-types/{id}` | Get a managed cluster type +[**get-managed-cluster-types**](#get-managed-cluster-types) | **Get** `/managed-cluster-types` | Get managed cluster types +[**update-managed-cluster-type**](#update-managed-cluster-type) | **Patch** `/managed-cluster-types/{id}` | Update a managed cluster type ## create-managed-cluster-type -Create new Managed Cluster Type +Create new managed cluster type Create a new Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. The API returns a result that includes the Managed Cluster Type ID @@ -100,7 +100,7 @@ func main() { [[Back to top]](#) ## delete-managed-cluster-type -Delete a Managed Cluster Type +Delete a managed cluster type Delete an existing Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. @@ -166,7 +166,7 @@ func main() { [[Back to top]](#) ## get-managed-cluster-type -Get a Managed Cluster Type +Get a managed cluster type Get a Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. @@ -233,7 +233,7 @@ func main() { [[Back to top]](#) ## get-managed-cluster-types -Get Managed Cluster Types +Get managed cluster types Get a list of Managed Cluster Types. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. @@ -304,7 +304,7 @@ func main() { [[Back to top]](#) ## update-managed-cluster-type -Update a Managed Cluster Type +Update a managed cluster type Update an existing Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClustersAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClustersAPI.md index 6a84edb78..250fee7f6 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClustersAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClustersAPI.md @@ -17,18 +17,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-managed-cluster**](#create-managed-cluster) | **Post** `/managed-clusters` | Create Create Managed Cluster -[**delete-managed-cluster**](#delete-managed-cluster) | **Delete** `/managed-clusters/{id}` | Delete Managed Cluster -[**get-client-log-configuration**](#get-client-log-configuration) | **Get** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration -[**get-managed-cluster**](#get-managed-cluster) | **Get** `/managed-clusters/{id}` | Get Managed Cluster -[**get-managed-clusters**](#get-managed-clusters) | **Get** `/managed-clusters` | Get Managed Clusters -[**put-client-log-configuration**](#put-client-log-configuration) | **Put** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration -[**update**](#update) | **Post** `/managed-clusters/{id}/manualUpgrade` | Trigger Manual Upgrade for Managed Cluster -[**update-managed-cluster**](#update-managed-cluster) | **Patch** `/managed-clusters/{id}` | Update Managed Cluster +[**create-managed-cluster**](#create-managed-cluster) | **Post** `/managed-clusters` | Create create managed cluster +[**delete-managed-cluster**](#delete-managed-cluster) | **Delete** `/managed-clusters/{id}` | Delete managed cluster +[**get-client-log-configuration**](#get-client-log-configuration) | **Get** `/managed-clusters/{id}/log-config` | Get managed cluster log configuration +[**get-managed-cluster**](#get-managed-cluster) | **Get** `/managed-clusters/{id}` | Get managed cluster +[**get-managed-clusters**](#get-managed-clusters) | **Get** `/managed-clusters` | Get managed clusters +[**put-client-log-configuration**](#put-client-log-configuration) | **Put** `/managed-clusters/{id}/log-config` | Update managed cluster log configuration +[**update**](#update) | **Post** `/managed-clusters/{id}/manualUpgrade` | Trigger manual upgrade for managed cluster +[**update-managed-cluster**](#update-managed-cluster) | **Patch** `/managed-clusters/{id}` | Update managed cluster ## create-managed-cluster -Create Create Managed Cluster +Create create managed cluster Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. @@ -104,7 +104,7 @@ func main() { [[Back to top]](#) ## delete-managed-cluster -Delete Managed Cluster +Delete managed cluster Delete an existing managed cluster. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-cluster) @@ -171,7 +171,7 @@ func main() { [[Back to top]](#) ## get-client-log-configuration -Get Managed Cluster Log Configuration +Get managed cluster log configuration Get a managed cluster's log configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-client-log-configuration) @@ -237,7 +237,7 @@ func main() { [[Back to top]](#) ## get-managed-cluster -Get Managed Cluster +Get managed cluster Get a managed cluster by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-cluster) @@ -303,7 +303,7 @@ func main() { [[Back to top]](#) ## get-managed-clusters -Get Managed Clusters +Get managed clusters List current organization's managed clusters, based on request context. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-clusters) @@ -371,7 +371,7 @@ func main() { [[Back to top]](#) ## put-client-log-configuration -Update Managed Cluster Log Configuration +Update managed cluster log configuration Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-client-log-configuration) @@ -444,7 +444,7 @@ func main() { [[Back to top]](#) ## update -Trigger Manual Upgrade for Managed Cluster +Trigger manual upgrade for managed cluster Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. @@ -511,7 +511,7 @@ func main() { [[Back to top]](#) ## update-managed-cluster -Update Managed Cluster +Update managed cluster Update an existing managed cluster. [API Spec](https://developer.sailpoint.com/docs/api/v2024/update-managed-cluster) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/MultiHostIntegrationAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/MultiHostIntegrationAPI.md index a75eb5f1b..7ca4fab89 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/MultiHostIntegrationAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/MultiHostIntegrationAPI.md @@ -18,23 +18,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-multi-host-integration**](#create-multi-host-integration) | **Post** `/multihosts` | Create Multi-Host Integration -[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **Post** `/multihosts/{multihostId}` | Create Sources Within Multi-Host Integration -[**delete-multi-host**](#delete-multi-host) | **Delete** `/multihosts/{multihostId}` | Delete Multi-Host Integration -[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **Get** `/multihosts/{multihostId}/acctAggregationGroups` | List Account-Aggregation-Groups by Multi-Host ID -[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **Get** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List Entitlement-Aggregation-Groups by Integration ID -[**get-multi-host-integrations**](#get-multi-host-integrations) | **Get** `/multihosts/{multihostId}` | Get Multi-Host Integration By ID -[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **Get** `/multihosts` | List All Existing Multi-Host Integrations -[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **Get** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors -[**get-multihost-integration-types**](#get-multihost-integration-types) | **Get** `/multihosts/types` | List Multi-Host Integration Types -[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **Get** `/multihosts/{multihostId}/sources` | List Sources Within Multi-Host Integration -[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **Post** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration -[**test-source-connection-multihost**](#test-source-connection-multihost) | **Get** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source -[**update-multi-host-sources**](#update-multi-host-sources) | **Patch** `/multihosts/{multihostId}` | Update Multi-Host Integration +[**create-multi-host-integration**](#create-multi-host-integration) | **Post** `/multihosts` | Create multi-host integration +[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **Post** `/multihosts/{multihostId}` | Create sources within multi-host integration +[**delete-multi-host**](#delete-multi-host) | **Delete** `/multihosts/{multihostId}` | Delete multi-host integration +[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **Get** `/multihosts/{multihostId}/acctAggregationGroups` | List account-aggregation-groups by multi-host id +[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **Get** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List entitlement-aggregation-groups by integration id +[**get-multi-host-integrations**](#get-multi-host-integrations) | **Get** `/multihosts/{multihostId}` | Get multi-host integration by id +[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **Get** `/multihosts` | List all existing multi-host integrations +[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **Get** `/multihosts/{multiHostId}/sources/errors` | List multi-host source creation errors +[**get-multihost-integration-types**](#get-multihost-integration-types) | **Get** `/multihosts/types` | List multi-host integration types +[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **Get** `/multihosts/{multihostId}/sources` | List sources within multi-host integration +[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **Post** `/multihosts/{multihostId}/sources/testConnection` | Test configuration for multi-host integration +[**test-source-connection-multihost**](#test-source-connection-multihost) | **Get** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test configuration for multi-host integration's single source +[**update-multi-host-sources**](#update-multi-host-sources) | **Patch** `/multihosts/{multihostId}` | Update multi-host integration ## create-multi-host-integration -Create Multi-Host Integration +Create multi-host integration This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -128,7 +128,7 @@ func main() { [[Back to top]](#) ## create-sources-within-multi-host -Create Sources Within Multi-Host Integration +Create sources within multi-host integration This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -202,7 +202,7 @@ func main() { [[Back to top]](#) ## delete-multi-host -Delete Multi-Host Integration +Delete multi-host integration Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. @@ -269,7 +269,7 @@ func main() { [[Back to top]](#) ## get-acct-aggregation-groups -List Account-Aggregation-Groups by Multi-Host ID +List account-aggregation-groups by multi-host id This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -340,7 +340,7 @@ func main() { [[Back to top]](#) ## get-entitlement-aggregation-groups -List Entitlement-Aggregation-Groups by Integration ID +List entitlement-aggregation-groups by integration id This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -412,7 +412,7 @@ func main() { [[Back to top]](#) ## get-multi-host-integrations -Get Multi-Host Integration By ID +Get multi-host integration by id Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. @@ -480,7 +480,7 @@ func main() { [[Back to top]](#) ## get-multi-host-integrations-list -List All Existing Multi-Host Integrations +List all existing multi-host integrations Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -554,7 +554,7 @@ func main() { [[Back to top]](#) ## get-multi-host-source-creation-errors -List Multi-Host Source Creation Errors +List multi-host source creation errors Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -622,7 +622,7 @@ func main() { [[Back to top]](#) ## get-multihost-integration-types -List Multi-Host Integration Types +List multi-host integration types This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -681,7 +681,7 @@ func main() { [[Back to top]](#) ## get-sources-within-multi-host -List Sources Within Multi-Host Integration +List sources within multi-host integration Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -759,7 +759,7 @@ func main() { [[Back to top]](#) ## test-connection-multi-host-sources -Test Configuration For Multi-Host Integration +Test configuration for multi-host integration This endpoint performs a more detailed validation of the Multi-Host Integration's configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -826,7 +826,7 @@ func main() { [[Back to top]](#) ## test-source-connection-multihost -Test Configuration For Multi-Host Integration's Single Source +Test configuration for multi-host integration's single source This endpoint performs a more detailed validation of the source's configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -897,7 +897,7 @@ func main() { [[Back to top]](#) ## update-multi-host-sources -Update Multi-Host Integration +Update multi-host integration Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/NonEmployeeLifecycleManagementAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/NonEmployeeLifecycleManagementAPI.md index e469f4efc..1cd1526ce 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/NonEmployeeLifecycleManagementAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/NonEmployeeLifecycleManagementAPI.md @@ -46,42 +46,42 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-non-employee-request**](#approve-non-employee-request) | **Post** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request -[**create-non-employee-record**](#create-non-employee-record) | **Post** `/non-employee-records` | Create Non-Employee Record -[**create-non-employee-request**](#create-non-employee-request) | **Post** `/non-employee-requests` | Create Non-Employee Request -[**create-non-employee-source**](#create-non-employee-source) | **Post** `/non-employee-sources` | Create Non-Employee Source -[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **Post** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source -[**delete-non-employee-record**](#delete-non-employee-record) | **Delete** `/non-employee-records/{id}` | Delete Non-Employee Record -[**delete-non-employee-records-in-bulk**](#delete-non-employee-records-in-bulk) | **Post** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records -[**delete-non-employee-request**](#delete-non-employee-request) | **Delete** `/non-employee-requests/{id}` | Delete Non-Employee Request -[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source -[**delete-non-employee-source**](#delete-non-employee-source) | **Delete** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source -[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source -[**export-non-employee-records**](#export-non-employee-records) | **Get** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV -[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **Get** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**approve-non-employee-request**](#approve-non-employee-request) | **Post** `/non-employee-approvals/{id}/approve` | Approve a non-employee request +[**create-non-employee-record**](#create-non-employee-record) | **Post** `/non-employee-records` | Create non-employee record +[**create-non-employee-request**](#create-non-employee-request) | **Post** `/non-employee-requests` | Create non-employee request +[**create-non-employee-source**](#create-non-employee-source) | **Post** `/non-employee-sources` | Create non-employee source +[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **Post** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new schema attribute for non-employee source +[**delete-non-employee-record**](#delete-non-employee-record) | **Delete** `/non-employee-records/{id}` | Delete non-employee record +[**delete-non-employee-records-in-bulk**](#delete-non-employee-records-in-bulk) | **Post** `/non-employee-records/bulk-delete` | Delete multiple non-employee records +[**delete-non-employee-request**](#delete-non-employee-request) | **Delete** `/non-employee-requests/{id}` | Delete non-employee request +[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a schema attribute for non-employee source +[**delete-non-employee-source**](#delete-non-employee-source) | **Delete** `/non-employee-sources/{sourceId}` | Delete non-employee source +[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for non-employee source +[**export-non-employee-records**](#export-non-employee-records) | **Get** `/non-employee-sources/{id}/non-employees/download` | Exports non-employee records to csv +[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **Get** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports source schema template [**get-non-employee-approval**](#get-non-employee-approval) | **Get** `/non-employee-approvals/{id}` | Get a non-employee approval item detail -[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **Get** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests +[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **Get** `/non-employee-approvals/summary/{requested-for}` | Get summary of non-employee approval requests [**get-non-employee-bulk-upload-status**](#get-non-employee-bulk-upload-status) | **Get** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source -[**get-non-employee-record**](#get-non-employee-record) | **Get** `/non-employee-records/{id}` | Get a Non-Employee Record -[**get-non-employee-request**](#get-non-employee-request) | **Get** `/non-employee-requests/{id}` | Get a Non-Employee Request -[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **Get** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests -[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **Get** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source -[**get-non-employee-source**](#get-non-employee-source) | **Get** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source -[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **Get** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source -[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **Post** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records -[**list-non-employee-approvals**](#list-non-employee-approvals) | **Get** `/non-employee-approvals` | Get List of Non-Employee Approval Requests -[**list-non-employee-records**](#list-non-employee-records) | **Get** `/non-employee-records` | List Non-Employee Records -[**list-non-employee-requests**](#list-non-employee-requests) | **Get** `/non-employee-requests` | List Non-Employee Requests -[**list-non-employee-sources**](#list-non-employee-sources) | **Get** `/non-employee-sources` | List Non-Employee Sources -[**patch-non-employee-record**](#patch-non-employee-record) | **Patch** `/non-employee-records/{id}` | Patch Non-Employee Record -[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **Patch** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source -[**patch-non-employee-source**](#patch-non-employee-source) | **Patch** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source -[**reject-non-employee-request**](#reject-non-employee-request) | **Post** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request -[**update-non-employee-record**](#update-non-employee-record) | **Put** `/non-employee-records/{id}` | Update Non-Employee Record +[**get-non-employee-record**](#get-non-employee-record) | **Get** `/non-employee-records/{id}` | Get a non-employee record +[**get-non-employee-request**](#get-non-employee-request) | **Get** `/non-employee-requests/{id}` | Get a non-employee request +[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **Get** `/non-employee-requests/summary/{requested-for}` | Get summary of non-employee requests +[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **Get** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get schema attribute non-employee source +[**get-non-employee-source**](#get-non-employee-source) | **Get** `/non-employee-sources/{sourceId}` | Get a non-employee source +[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **Get** `/non-employee-sources/{sourceId}/schema-attributes` | List schema attributes non-employee source +[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **Post** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or updates, non-employee records +[**list-non-employee-approvals**](#list-non-employee-approvals) | **Get** `/non-employee-approvals` | Get list of non-employee approval requests +[**list-non-employee-records**](#list-non-employee-records) | **Get** `/non-employee-records` | List non-employee records +[**list-non-employee-requests**](#list-non-employee-requests) | **Get** `/non-employee-requests` | List non-employee requests +[**list-non-employee-sources**](#list-non-employee-sources) | **Get** `/non-employee-sources` | List non-employee sources +[**patch-non-employee-record**](#patch-non-employee-record) | **Patch** `/non-employee-records/{id}` | Patch non-employee record +[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **Patch** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a schema attribute for non-employee source +[**patch-non-employee-source**](#patch-non-employee-source) | **Patch** `/non-employee-sources/{sourceId}` | Patch a non-employee source +[**reject-non-employee-request**](#reject-non-employee-request) | **Post** `/non-employee-approvals/{id}/reject` | Reject a non-employee request +[**update-non-employee-record**](#update-non-employee-record) | **Put** `/non-employee-records/{id}` | Update non-employee record ## approve-non-employee-request -Approve a Non-Employee Request +Approve a non-employee request Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. [API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-non-employee-request) @@ -156,7 +156,7 @@ func main() { [[Back to top]](#) ## create-non-employee-record -Create Non-Employee Record +Create non-employee record This request will create a non-employee record. Requires role context of `idn:nesr:create` @@ -238,7 +238,7 @@ func main() { [[Back to top]](#) ## create-non-employee-request -Create Non-Employee Request +Create non-employee request This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-request) @@ -319,7 +319,7 @@ func main() { [[Back to top]](#) ## create-non-employee-source -Create Non-Employee Source +Create non-employee source Create a non-employee source. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-source) @@ -411,7 +411,7 @@ func main() { [[Back to top]](#) ## create-non-employee-source-schema-attributes -Create a new Schema Attribute for Non-Employee Source +Create a new schema attribute for non-employee source This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. Requires role context of `idn:nesr:create` @@ -492,7 +492,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-record -Delete Non-Employee Record +Delete non-employee record This request will delete a non-employee record. Requires role context of `idn:nesr:delete` @@ -558,7 +558,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-records-in-bulk -Delete Multiple Non-Employee Records +Delete multiple non-employee records This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-records-in-bulk) @@ -624,7 +624,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-request -Delete Non-Employee Request +Delete non-employee request This request will delete a non-employee request. Requires role context of `idn:nesr:delete` @@ -690,7 +690,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-schema-attribute -Delete a Schema Attribute for Non-Employee Source +Delete a schema attribute for non-employee source This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` @@ -760,7 +760,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-source -Delete Non-Employee Source +Delete non-employee source This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-source) @@ -825,7 +825,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-source-schema-attributes -Delete all custom schema attributes for Non-Employee Source +Delete all custom schema attributes for non-employee source This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-source-schema-attributes) @@ -890,7 +890,7 @@ func main() { [[Back to top]](#) ## export-non-employee-records -Exports Non-Employee Records to CSV +Exports non-employee records to csv This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` [API Spec](https://developer.sailpoint.com/docs/api/v2024/export-non-employee-records) @@ -955,7 +955,7 @@ func main() { [[Back to top]](#) ## export-non-employee-source-schema-template -Exports Source Schema Template +Exports source schema template This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` [API Spec](https://developer.sailpoint.com/docs/api/v2024/export-non-employee-source-schema-template) @@ -1091,7 +1091,7 @@ func main() { [[Back to top]](#) ## get-non-employee-approval-summary -Get Summary of Non-Employee Approval Requests +Get summary of non-employee approval requests This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. @@ -1229,7 +1229,7 @@ func main() { [[Back to top]](#) ## get-non-employee-record -Get a Non-Employee Record +Get a non-employee record This gets a non-employee record. Requires role context of `idn:nesr:read` @@ -1296,7 +1296,7 @@ func main() { [[Back to top]](#) ## get-non-employee-request -Get a Non-Employee Request +Get a non-employee request This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user @@ -1366,7 +1366,7 @@ func main() { [[Back to top]](#) ## get-non-employee-request-summary -Get Summary of Non-Employee Requests +Get summary of non-employee requests This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. @@ -1436,7 +1436,7 @@ func main() { [[Back to top]](#) ## get-non-employee-schema-attribute -Get Schema Attribute Non-Employee Source +Get schema attribute non-employee source This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-schema-attribute) @@ -1505,7 +1505,7 @@ func main() { [[Back to top]](#) ## get-non-employee-source -Get a Non-Employee Source +Get a non-employee source This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. @@ -1575,7 +1575,7 @@ func main() { [[Back to top]](#) ## get-non-employee-source-schema-attributes -List Schema Attributes Non-Employee Source +List schema attributes non-employee source This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. @@ -1642,7 +1642,7 @@ func main() { [[Back to top]](#) ## import-non-employee-records-in-bulk -Imports, or Updates, Non-Employee Records +Imports, or updates, non-employee records This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` [API Spec](https://developer.sailpoint.com/docs/api/v2024/import-non-employee-records-in-bulk) @@ -1710,7 +1710,7 @@ func main() { [[Back to top]](#) ## list-non-employee-approvals -Get List of Non-Employee Approval Requests +Get list of non-employee approval requests This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they @@ -1786,7 +1786,7 @@ func main() { [[Back to top]](#) ## list-non-employee-records -List Non-Employee Records +List non-employee records This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. @@ -1858,7 +1858,7 @@ func main() { [[Back to top]](#) ## list-non-employee-requests -List Non-Employee Requests +List non-employee requests This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. @@ -1934,7 +1934,7 @@ func main() { [[Back to top]](#) ## list-non-employee-sources -List Non-Employee Sources +List non-employee sources Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. @@ -2008,7 +2008,7 @@ func main() { [[Back to top]](#) ## patch-non-employee-record -Patch Non-Employee Record +Patch non-employee record This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. @@ -2085,7 +2085,7 @@ func main() { [[Back to top]](#) ## patch-non-employee-schema-attribute -Patch a Schema Attribute for Non-Employee Source +Patch a schema attribute for non-employee source This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` @@ -2163,7 +2163,7 @@ func main() { [[Back to top]](#) ## patch-non-employee-source -Patch a Non-Employee Source +Patch a non-employee source patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-non-employee-source) @@ -2236,7 +2236,7 @@ func main() { [[Back to top]](#) ## reject-non-employee-request -Reject a Non-Employee Request +Reject a non-employee request This endpoint will reject an approval item request and notify user. The current user must be the requested approver. [API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-non-employee-request) @@ -2311,7 +2311,7 @@ func main() { [[Back to top]](#) ## update-non-employee-record -Update Non-Employee Record +Update non-employee record This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/NotificationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/NotificationsAPI.md index fe6520c27..e4b7cd30a 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/NotificationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/NotificationsAPI.md @@ -15,21 +15,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-domain-dkim**](#create-domain-dkim) | **Post** `/verified-domains` | Verify domain address via DKIM -[**create-notification-template**](#create-notification-template) | **Post** `/notification-templates` | Create Notification Template -[**create-verified-from-address**](#create-verified-from-address) | **Post** `/verified-from-addresses` | Create Verified From Address -[**delete-notification-templates-in-bulk**](#delete-notification-templates-in-bulk) | **Post** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates -[**delete-verified-from-address**](#delete-verified-from-address) | **Delete** `/verified-from-addresses/{id}` | Delete Verified From Address -[**get-dkim-attributes**](#get-dkim-attributes) | **Get** `/verified-domains` | Get DKIM Attributes -[**get-mail-from-attributes**](#get-mail-from-attributes) | **Get** `/mail-from-attributes/{identity}` | Get MAIL FROM Attributes -[**get-notification-template**](#get-notification-template) | **Get** `/notification-templates/{id}` | Get Notification Template By Id -[**get-notifications-template-context**](#get-notifications-template-context) | **Get** `/notification-template-context` | Get Notification Template Context -[**list-from-addresses**](#list-from-addresses) | **Get** `/verified-from-addresses` | List From Addresses -[**list-notification-preferences**](#list-notification-preferences) | **Get** `/notification-preferences/{key}` | List Notification Preferences for tenant. -[**list-notification-template-defaults**](#list-notification-template-defaults) | **Get** `/notification-template-defaults` | List Notification Template Defaults -[**list-notification-templates**](#list-notification-templates) | **Get** `/notification-templates` | List Notification Templates -[**put-mail-from-attributes**](#put-mail-from-attributes) | **Put** `/mail-from-attributes` | Change MAIL FROM domain -[**send-test-notification**](#send-test-notification) | **Post** `/send-test-notification` | Send Test Notification +[**create-domain-dkim**](#create-domain-dkim) | **Post** `/verified-domains` | Verify domain address via dkim +[**create-notification-template**](#create-notification-template) | **Post** `/notification-templates` | Create notification template +[**create-verified-from-address**](#create-verified-from-address) | **Post** `/verified-from-addresses` | Create verified from address +[**delete-notification-templates-in-bulk**](#delete-notification-templates-in-bulk) | **Post** `/notification-templates/bulk-delete` | Bulk delete notification templates +[**delete-verified-from-address**](#delete-verified-from-address) | **Delete** `/verified-from-addresses/{id}` | Delete verified from address +[**get-dkim-attributes**](#get-dkim-attributes) | **Get** `/verified-domains` | Get dkim attributes +[**get-mail-from-attributes**](#get-mail-from-attributes) | **Get** `/mail-from-attributes/{identity}` | Get mail from attributes +[**get-notification-template**](#get-notification-template) | **Get** `/notification-templates/{id}` | Get notification template by id +[**get-notifications-template-context**](#get-notifications-template-context) | **Get** `/notification-template-context` | Get notification template context +[**list-from-addresses**](#list-from-addresses) | **Get** `/verified-from-addresses` | List from addresses +[**list-notification-preferences**](#list-notification-preferences) | **Get** `/notification-preferences/{key}` | List notification preferences for tenant. +[**list-notification-template-defaults**](#list-notification-template-defaults) | **Get** `/notification-template-defaults` | List notification template defaults +[**list-notification-templates**](#list-notification-templates) | **Get** `/notification-templates` | List notification templates +[**put-mail-from-attributes**](#put-mail-from-attributes) | **Put** `/mail-from-attributes` | Change mail from domain +[**send-test-notification**](#send-test-notification) | **Post** `/send-test-notification` | Send test notification ## create-domain-dkim @@ -44,7 +44,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Verify domain address via DKIM +Verify domain address via dkim Create a domain to be verified via DKIM (DomainKeys Identified Mail) [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-domain-dkim) @@ -126,7 +126,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create Notification Template +Create notification template This creates a template for your site. You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. @@ -225,7 +225,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create Verified From Address +Create verified from address Create a new sender email address and initiate verification process. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-verified-from-address) @@ -310,7 +310,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Bulk Delete Notification Templates +Bulk delete notification templates This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-notification-templates-in-bulk) @@ -389,7 +389,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Verified From Address +Delete verified from address Delete a verified sender email address [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-verified-from-address) @@ -467,7 +467,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get DKIM Attributes +Get dkim attributes Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-dkim-attributes) @@ -540,7 +540,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get MAIL FROM Attributes +Get mail from attributes Retrieve MAIL FROM attributes for a given AWS SES identity. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mail-from-attributes) @@ -615,7 +615,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Notification Template By Id +Get notification template by id This gets a template that you have modified for your site by Id. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-notification-template) @@ -694,7 +694,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Notification Template Context +Get notification template context The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). @@ -768,7 +768,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List From Addresses +List from addresses Retrieve a list of sender email addresses and their verification statuses [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-from-addresses) @@ -851,7 +851,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Notification Preferences for tenant. +List notification preferences for tenant. Returns a list of notification preferences for tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-preferences) @@ -924,7 +924,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Notification Template Defaults +List notification template defaults This lists the default templates used for notifications, such as emails from IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-template-defaults) @@ -1003,7 +1003,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Notification Templates +List notification templates This lists the templates that you have modified for your site. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-templates) @@ -1082,7 +1082,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Change MAIL FROM domain +Change mail from domain Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-mail-from-attributes) @@ -1165,7 +1165,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Send Test Notification +Send test notification Send a Test Notification [API Spec](https://developer.sailpoint.com/docs/api/v2024/send-test-notification) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/OAuthClientsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/OAuthClientsAPI.md index 942e0f06c..da5b0e53d 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/OAuthClientsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/OAuthClientsAPI.md @@ -18,15 +18,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-oauth-client**](#create-oauth-client) | **Post** `/oauth-clients` | Create OAuth Client -[**delete-oauth-client**](#delete-oauth-client) | **Delete** `/oauth-clients/{id}` | Delete OAuth Client -[**get-oauth-client**](#get-oauth-client) | **Get** `/oauth-clients/{id}` | Get OAuth Client -[**list-oauth-clients**](#list-oauth-clients) | **Get** `/oauth-clients` | List OAuth Clients -[**patch-oauth-client**](#patch-oauth-client) | **Patch** `/oauth-clients/{id}` | Patch OAuth Client +[**create-oauth-client**](#create-oauth-client) | **Post** `/oauth-clients` | Create oauth client +[**delete-oauth-client**](#delete-oauth-client) | **Delete** `/oauth-clients/{id}` | Delete oauth client +[**get-oauth-client**](#get-oauth-client) | **Get** `/oauth-clients/{id}` | Get oauth client +[**list-oauth-clients**](#list-oauth-clients) | **Get** `/oauth-clients` | List oauth clients +[**patch-oauth-client**](#patch-oauth-client) | **Patch** `/oauth-clients/{id}` | Patch oauth client ## create-oauth-client -Create OAuth Client +Create oauth client This creates an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-oauth-client) @@ -109,7 +109,7 @@ func main() { [[Back to top]](#) ## delete-oauth-client -Delete OAuth Client +Delete oauth client This deletes an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-oauth-client) @@ -174,7 +174,7 @@ func main() { [[Back to top]](#) ## get-oauth-client -Get OAuth Client +Get oauth client This gets details of an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-oauth-client) @@ -240,7 +240,7 @@ func main() { [[Back to top]](#) ## list-oauth-clients -List OAuth Clients +List oauth clients This gets a list of OAuth clients. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-oauth-clients) @@ -302,7 +302,7 @@ func main() { [[Back to top]](#) ## patch-oauth-client -Patch OAuth Client +Patch oauth client This performs a targeted update to the field(s) of an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-oauth-client) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/OrgConfigAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/OrgConfigAPI.md index e507a0cf4..0817951dc 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/OrgConfigAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/OrgConfigAPI.md @@ -17,9 +17,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-org-config**](#get-org-config) | **Get** `/org-config` | Get Org Config Settings -[**get-valid-time-zones**](#get-valid-time-zones) | **Get** `/org-config/valid-time-zones` | Get Valid Time Zones -[**patch-org-config**](#patch-org-config) | **Patch** `/org-config` | Patch Org Config +[**get-org-config**](#get-org-config) | **Get** `/org-config` | Get org config settings +[**get-valid-time-zones**](#get-valid-time-zones) | **Get** `/org-config/valid-time-zones` | Get valid time zones +[**patch-org-config**](#patch-org-config) | **Patch** `/org-config` | Patch org config ## get-org-config @@ -34,7 +34,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Org Config Settings +Get org config settings Get the current organization's configuration settings, only external accessible properties. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-org-config) @@ -107,7 +107,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Valid Time Zones +Get valid time zones List the valid time zones that can be set in organization configurations. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-valid-time-zones) @@ -186,7 +186,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch Org Config +Patch org config Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone. [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-org-config) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordConfigurationAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordConfigurationAPI.md index 4ceb02473..ec9790b96 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordConfigurationAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordConfigurationAPI.md @@ -21,13 +21,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-password-org-config**](#create-password-org-config) | **Post** `/password-org-config` | Create Password Org Config -[**get-password-org-config**](#get-password-org-config) | **Get** `/password-org-config` | Get Password Org Config -[**put-password-org-config**](#put-password-org-config) | **Put** `/password-org-config` | Update Password Org Config +[**create-password-org-config**](#create-password-org-config) | **Post** `/password-org-config` | Create password org config +[**get-password-org-config**](#get-password-org-config) | **Get** `/password-org-config` | Get password org config +[**put-password-org-config**](#put-password-org-config) | **Put** `/password-org-config` | Update password org config ## create-password-org-config -Create Password Org Config +Create password org config This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' @@ -101,7 +101,7 @@ func main() { [[Back to top]](#) ## get-password-org-config -Get Password Org Config +Get password org config This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-org-config) @@ -158,7 +158,7 @@ func main() { [[Back to top]](#) ## put-password-org-config -Update Password Org Config +Update password org config This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordDictionaryAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordDictionaryAPI.md index e82176416..4c65ac49e 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordDictionaryAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordDictionaryAPI.md @@ -62,12 +62,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-password-dictionary**](#get-password-dictionary) | **Get** `/password-dictionary` | Get Password Dictionary -[**put-password-dictionary**](#put-password-dictionary) | **Put** `/password-dictionary` | Update Password Dictionary +[**get-password-dictionary**](#get-password-dictionary) | **Get** `/password-dictionary` | Get password dictionary +[**put-password-dictionary**](#put-password-dictionary) | **Put** `/password-dictionary` | Update password dictionary ## get-password-dictionary -Get Password Dictionary +Get password dictionary This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing @@ -152,7 +152,7 @@ func main() { [[Back to top]](#) ## put-password-dictionary -Update Password Dictionary +Update password dictionary This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordManagementAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordManagementAPI.md index f498c42b9..c9bc9f7e4 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordManagementAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordManagementAPI.md @@ -40,9 +40,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-digit-token**](#create-digit-token) | **Post** `/generate-password-reset-token/digit` | Generate a digit token -[**get-password-change-status**](#get-password-change-status) | **Get** `/password-change-status/{id}` | Get Password Change Request Status -[**query-password-info**](#query-password-info) | **Post** `/query-password-info` | Query Password Info -[**set-password**](#set-password) | **Post** `/set-password` | Set Identity's Password +[**get-password-change-status**](#get-password-change-status) | **Get** `/password-change-status/{id}` | Get password change request status +[**query-password-info**](#query-password-info) | **Post** `/query-password-info` | Query password info +[**set-password**](#set-password) | **Post** `/set-password` | Set identity's password ## create-digit-token @@ -130,7 +130,7 @@ func main() { [[Back to top]](#) ## get-password-change-status -Get Password Change Request Status +Get password change request status This API returns the status of a password change request. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-change-status) @@ -196,7 +196,7 @@ func main() { [[Back to top]](#) ## query-password-info -Query Password Info +Query password info This API is used to query password related information. @@ -267,7 +267,7 @@ func main() { [[Back to top]](#) ## set-password -Set Identity's Password +Set identity's password This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordPoliciesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordPoliciesAPI.md index 52a30c6ab..ccacb3dae 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordPoliciesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordPoliciesAPI.md @@ -23,15 +23,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-password-policy**](#create-password-policy) | **Post** `/password-policies` | Create Password Policy -[**delete-password-policy**](#delete-password-policy) | **Delete** `/password-policies/{id}` | Delete Password Policy by ID -[**get-password-policy-by-id**](#get-password-policy-by-id) | **Get** `/password-policies/{id}` | Get Password Policy by ID -[**list-password-policies**](#list-password-policies) | **Get** `/password-policies` | List Password Policies -[**set-password-policy**](#set-password-policy) | **Put** `/password-policies/{id}` | Update Password Policy by ID +[**create-password-policy**](#create-password-policy) | **Post** `/password-policies` | Create password policy +[**delete-password-policy**](#delete-password-policy) | **Delete** `/password-policies/{id}` | Delete password policy by id +[**get-password-policy-by-id**](#get-password-policy-by-id) | **Get** `/password-policies/{id}` | Get password policy by id +[**list-password-policies**](#list-password-policies) | **Get** `/password-policies` | List password policies +[**set-password-policy**](#set-password-policy) | **Put** `/password-policies/{id}` | Update password policy by id ## create-password-policy -Create Password Policy +Create password policy This API creates the specified password policy. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-policy) @@ -130,7 +130,7 @@ func main() { [[Back to top]](#) ## delete-password-policy -Delete Password Policy by ID +Delete password policy by id This API deletes the specified password policy. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-password-policy) @@ -195,7 +195,7 @@ func main() { [[Back to top]](#) ## get-password-policy-by-id -Get Password Policy by ID +Get password policy by id This API returns the password policy for the specified ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-policy-by-id) @@ -261,7 +261,7 @@ func main() { [[Back to top]](#) ## list-password-policies -List Password Policies +List password policies This gets list of all Password Policies. Requires role of ORG_ADMIN @@ -328,7 +328,7 @@ func main() { [[Back to top]](#) ## set-password-policy -Update Password Policy by ID +Update password policy by id This API updates the specified password policy. [API Spec](https://developer.sailpoint.com/docs/api/v2024/set-password-policy) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordSyncGroupsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordSyncGroupsAPI.md index c36c85ffa..461381016 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordSyncGroupsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordSyncGroupsAPI.md @@ -47,15 +47,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-password-sync-group**](#create-password-sync-group) | **Post** `/password-sync-groups` | Create Password Sync Group -[**delete-password-sync-group**](#delete-password-sync-group) | **Delete** `/password-sync-groups/{id}` | Delete Password Sync Group by ID -[**get-password-sync-group**](#get-password-sync-group) | **Get** `/password-sync-groups/{id}` | Get Password Sync Group by ID -[**get-password-sync-groups**](#get-password-sync-groups) | **Get** `/password-sync-groups` | Get Password Sync Group List -[**update-password-sync-group**](#update-password-sync-group) | **Put** `/password-sync-groups/{id}` | Update Password Sync Group by ID +[**create-password-sync-group**](#create-password-sync-group) | **Post** `/password-sync-groups` | Create password sync group +[**delete-password-sync-group**](#delete-password-sync-group) | **Delete** `/password-sync-groups/{id}` | Delete password sync group by id +[**get-password-sync-group**](#get-password-sync-group) | **Get** `/password-sync-groups/{id}` | Get password sync group by id +[**get-password-sync-groups**](#get-password-sync-groups) | **Get** `/password-sync-groups` | Get password sync group list +[**update-password-sync-group**](#update-password-sync-group) | **Put** `/password-sync-groups/{id}` | Update password sync group by id ## create-password-sync-group -Create Password Sync Group +Create password sync group This API creates a password sync group based on the specifications provided. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-sync-group) @@ -129,7 +129,7 @@ func main() { [[Back to top]](#) ## delete-password-sync-group -Delete Password Sync Group by ID +Delete password sync group by id This API deletes the specified password sync group. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-password-sync-group) @@ -194,7 +194,7 @@ func main() { [[Back to top]](#) ## get-password-sync-group -Get Password Sync Group by ID +Get password sync group by id This API returns the sync group for the specified ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-sync-group) @@ -260,7 +260,7 @@ func main() { [[Back to top]](#) ## get-password-sync-groups -Get Password Sync Group List +Get password sync group list This API returns a list of password sync groups. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-sync-groups) @@ -326,7 +326,7 @@ func main() { [[Back to top]](#) ## update-password-sync-group -Update Password Sync Group by ID +Update password sync group by id This API updates the specified password sync group. [API Spec](https://developer.sailpoint.com/docs/api/v2024/update-password-sync-group) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PersonalAccessTokensAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PersonalAccessTokensAPI.md index 9ac93bfc4..6dad2b975 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/PersonalAccessTokensAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PersonalAccessTokensAPI.md @@ -26,14 +26,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-personal-access-token**](#create-personal-access-token) | **Post** `/personal-access-tokens` | Create Personal Access Token -[**delete-personal-access-token**](#delete-personal-access-token) | **Delete** `/personal-access-tokens/{id}` | Delete Personal Access Token -[**list-personal-access-tokens**](#list-personal-access-tokens) | **Get** `/personal-access-tokens` | List Personal Access Tokens -[**patch-personal-access-token**](#patch-personal-access-token) | **Patch** `/personal-access-tokens/{id}` | Patch Personal Access Token +[**create-personal-access-token**](#create-personal-access-token) | **Post** `/personal-access-tokens` | Create personal access token +[**delete-personal-access-token**](#delete-personal-access-token) | **Delete** `/personal-access-tokens/{id}` | Delete personal access token +[**list-personal-access-tokens**](#list-personal-access-tokens) | **Get** `/personal-access-tokens` | List personal access tokens +[**patch-personal-access-token**](#patch-personal-access-token) | **Patch** `/personal-access-tokens/{id}` | Patch personal access token ## create-personal-access-token -Create Personal Access Token +Create personal access token This creates a personal access token. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-personal-access-token) @@ -104,7 +104,7 @@ func main() { [[Back to top]](#) ## delete-personal-access-token -Delete Personal Access Token +Delete personal access token This deletes a personal access token. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-personal-access-token) @@ -169,7 +169,7 @@ func main() { [[Back to top]](#) ## list-personal-access-tokens -List Personal Access Tokens +List personal access tokens This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-personal-access-tokens) @@ -233,7 +233,7 @@ func main() { [[Back to top]](#) ## patch-personal-access-token -Patch Personal Access Token +Patch personal access token This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PublicIdentitiesConfigAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PublicIdentitiesConfigAPI.md index 9826c29fb..cb107dd14 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/PublicIdentitiesConfigAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PublicIdentitiesConfigAPI.md @@ -25,12 +25,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-public-identity-config**](#get-public-identity-config) | **Get** `/public-identities-config` | Get the Public Identities Configuration -[**update-public-identity-config**](#update-public-identity-config) | **Put** `/public-identities-config` | Update the Public Identities Configuration +[**get-public-identity-config**](#get-public-identity-config) | **Get** `/public-identities-config` | Get the public identities configuration +[**update-public-identity-config**](#update-public-identity-config) | **Put** `/public-identities-config` | Update the public identities configuration ## get-public-identity-config -Get the Public Identities Configuration +Get the public identities configuration Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-public-identity-config) @@ -87,7 +87,7 @@ func main() { [[Back to top]](#) ## update-public-identity-config -Update the Public Identities Configuration +Update the public identities configuration Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. [API Spec](https://developer.sailpoint.com/docs/api/v2024/update-public-identity-config) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ReportsDataExtractionAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ReportsDataExtractionAPI.md index 952e9c5f3..d3b73c2fc 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/ReportsDataExtractionAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ReportsDataExtractionAPI.md @@ -18,14 +18,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**cancel-report**](#cancel-report) | **Post** `/reports/{id}/cancel` | Cancel Report -[**get-report**](#get-report) | **Get** `/reports/{taskResultId}` | Get Report File -[**get-report-result**](#get-report-result) | **Get** `/reports/{taskResultId}/result` | Get Report Result -[**start-report**](#start-report) | **Post** `/reports/run` | Run Report +[**cancel-report**](#cancel-report) | **Post** `/reports/{id}/cancel` | Cancel report +[**get-report**](#get-report) | **Get** `/reports/{taskResultId}` | Get report file +[**get-report-result**](#get-report-result) | **Get** `/reports/{taskResultId}/result` | Get report result +[**start-report**](#start-report) | **Post** `/reports/run` | Run report ## cancel-report -Cancel Report +Cancel report Cancels a running report. [API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-report) @@ -90,7 +90,7 @@ func main() { [[Back to top]](#) ## get-report -Get Report File +Get report file Gets a report in file format. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-report) @@ -162,7 +162,7 @@ func main() { [[Back to top]](#) ## get-report-result -Get Report Result +Get report result Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-report-result) @@ -230,7 +230,7 @@ func main() { [[Back to top]](#) ## start-report -Run Report +Run report Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. [API Spec](https://developer.sailpoint.com/docs/api/v2024/start-report) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/RequestableObjectsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/RequestableObjectsAPI.md index 4e3065a25..2444d68ef 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/RequestableObjectsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/RequestableObjectsAPI.md @@ -18,11 +18,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**list-requestable-objects**](#list-requestable-objects) | **Get** `/requestable-objects` | Requestable Objects List +[**list-requestable-objects**](#list-requestable-objects) | **Get** `/requestable-objects` | Requestable objects list ## list-requestable-objects -Requestable Objects List +Requestable objects list Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/RolesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/RolesAPI.md index 0ba0d2072..13dfdb6ff 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/RolesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/RolesAPI.md @@ -52,26 +52,26 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-role**](#create-role) | **Post** `/roles` | Create a Role -[**delete-bulk-roles**](#delete-bulk-roles) | **Post** `/roles/bulk-delete` | Delete Role(s) -[**delete-metadata-from-role-by-key-and-value**](#delete-metadata-from-role-by-key-and-value) | **Delete** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a Metadata From Role. -[**delete-role**](#delete-role) | **Delete** `/roles/{id}` | Delete a Role -[**get-bulk-update-status**](#get-bulk-update-status) | **Get** `/roles/access-model-metadata/bulk-update` | Get Bulk-Update Statuses -[**get-bulk-update-status-by-id**](#get-bulk-update-status-by-id) | **Get** `/roles/access-model-metadata/bulk-update/id` | Get Bulk-Update Status by ID -[**get-role**](#get-role) | **Get** `/roles/{id}` | Get a Role -[**get-role-assigned-identities**](#get-role-assigned-identities) | **Get** `/roles/{id}/assigned-identities` | List Identities assigned a Role -[**get-role-entitlements**](#get-role-entitlements) | **Get** `/roles/{id}/entitlements` | List Role's Entitlements -[**list-roles**](#list-roles) | **Get** `/roles` | List Roles -[**patch-role**](#patch-role) | **Patch** `/roles/{id}` | Patch a specified Role -[**search-roles-by-filter**](#search-roles-by-filter) | **Post** `/roles/filter` | Filter Roles by Metadata -[**update-attribute-key-and-value-to-role**](#update-attribute-key-and-value-to-role) | **Post** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a Metadata to Role. -[**update-roles-metadata-by-filter**](#update-roles-metadata-by-filter) | **Post** `/roles/access-model-metadata/bulk-update/filter` | Bulk-Update Roles' Metadata by Filters -[**update-roles-metadata-by-ids**](#update-roles-metadata-by-ids) | **Post** `/roles/access-model-metadata/bulk-update/ids` | Bulk-Update Roles' Metadata by ID -[**update-roles-metadata-by-query**](#update-roles-metadata-by-query) | **Post** `/roles/access-model-metadata/bulk-update/query` | Bulk-Update Roles' Metadata by Query +[**create-role**](#create-role) | **Post** `/roles` | Create a role +[**delete-bulk-roles**](#delete-bulk-roles) | **Post** `/roles/bulk-delete` | Delete role(s) +[**delete-metadata-from-role-by-key-and-value**](#delete-metadata-from-role-by-key-and-value) | **Delete** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a metadata from role. +[**delete-role**](#delete-role) | **Delete** `/roles/{id}` | Delete a role +[**get-bulk-update-status**](#get-bulk-update-status) | **Get** `/roles/access-model-metadata/bulk-update` | Get bulk-update statuses +[**get-bulk-update-status-by-id**](#get-bulk-update-status-by-id) | **Get** `/roles/access-model-metadata/bulk-update/id` | Get bulk-update status by id +[**get-role**](#get-role) | **Get** `/roles/{id}` | Get a role +[**get-role-assigned-identities**](#get-role-assigned-identities) | **Get** `/roles/{id}/assigned-identities` | List identities assigned a role +[**get-role-entitlements**](#get-role-entitlements) | **Get** `/roles/{id}/entitlements` | List role's entitlements +[**list-roles**](#list-roles) | **Get** `/roles` | List roles +[**patch-role**](#patch-role) | **Patch** `/roles/{id}` | Patch a specified role +[**search-roles-by-filter**](#search-roles-by-filter) | **Post** `/roles/filter` | Filter roles by metadata +[**update-attribute-key-and-value-to-role**](#update-attribute-key-and-value-to-role) | **Post** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a metadata to role. +[**update-roles-metadata-by-filter**](#update-roles-metadata-by-filter) | **Post** `/roles/access-model-metadata/bulk-update/filter` | Bulk-update roles' metadata by filters +[**update-roles-metadata-by-ids**](#update-roles-metadata-by-ids) | **Post** `/roles/access-model-metadata/bulk-update/ids` | Bulk-update roles' metadata by id +[**update-roles-metadata-by-query**](#update-roles-metadata-by-query) | **Post** `/roles/access-model-metadata/bulk-update/query` | Bulk-update roles' metadata by query ## create-role -Create a Role +Create a role This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. @@ -302,7 +302,7 @@ func main() { [[Back to top]](#) ## delete-bulk-roles -Delete Role(s) +Delete role(s) This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. @@ -374,7 +374,7 @@ func main() { [[Back to top]](#) ## delete-metadata-from-role-by-key-and-value -Remove a Metadata From Role. +Remove a metadata from role. This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-metadata-from-role-by-key-and-value) @@ -445,7 +445,7 @@ func main() { [[Back to top]](#) ## delete-role -Delete a Role +Delete a role This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. @@ -512,7 +512,7 @@ func main() { [[Back to top]](#) ## get-bulk-update-status -Get Bulk-Update Statuses +Get bulk-update statuses This API returns a list of all unfinished bulk update process status of the tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-bulk-update-status) @@ -569,7 +569,7 @@ func main() { [[Back to top]](#) ## get-bulk-update-status-by-id -Get Bulk-Update Status by ID +Get bulk-update status by id This API initial a request for one bulk update's status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. @@ -637,7 +637,7 @@ func main() { [[Back to top]](#) ## get-role -Get a Role +Get a role This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. @@ -704,7 +704,7 @@ func main() { [[Back to top]](#) ## get-role-assigned-identities -List Identities assigned a Role +List identities assigned a role [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assigned-identities) @@ -791,7 +791,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Role's Entitlements +List role's entitlements Get a list of entitlements associated with a specified role. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-entitlements) @@ -869,7 +869,7 @@ func main() { [[Back to top]](#) ## list-roles -List Roles +List roles This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. @@ -947,7 +947,7 @@ func main() { [[Back to top]](#) ## patch-role -Patch a specified Role +Patch a specified role This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: @@ -1040,7 +1040,7 @@ func main() { [[Back to top]](#) ## search-roles-by-filter -Filter Roles by Metadata +Filter roles by metadata This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. @@ -1123,7 +1123,7 @@ func main() { [[Back to top]](#) ## update-attribute-key-and-value-to-role -Add a Metadata to Role. +Add a metadata to role. This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. [API Spec](https://developer.sailpoint.com/docs/api/v2024/update-attribute-key-and-value-to-role) @@ -1195,7 +1195,7 @@ func main() { [[Back to top]](#) ## update-roles-metadata-by-filter -Bulk-Update Roles' Metadata by Filters +Bulk-update roles' metadata by filters This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. @@ -1273,7 +1273,7 @@ func main() { [[Back to top]](#) ## update-roles-metadata-by-ids -Bulk-Update Roles' Metadata by ID +Bulk-update roles' metadata by id This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. @@ -1351,7 +1351,7 @@ func main() { [[Back to top]](#) ## update-roles-metadata-by-query -Bulk-Update Roles' Metadata by Query +Bulk-update roles' metadata by query This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SIMIntegrationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SIMIntegrationsAPI.md index 84c9b85f1..6fcc0dd3a 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/SIMIntegrationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SIMIntegrationsAPI.md @@ -22,13 +22,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-sim-integration**](#create-sim-integration) | **Post** `/sim-integrations` | Create new SIM integration -[**delete-sim-integration**](#delete-sim-integration) | **Delete** `/sim-integrations/{id}` | Delete a SIM integration -[**get-sim-integration**](#get-sim-integration) | **Get** `/sim-integrations/{id}` | Get a SIM integration details. -[**get-sim-integrations**](#get-sim-integrations) | **Get** `/sim-integrations` | List the existing SIM integrations. -[**patch-before-provisioning-rule**](#patch-before-provisioning-rule) | **Patch** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute. -[**patch-sim-attributes**](#patch-sim-attributes) | **Patch** `/sim-integrations/{id}` | Patch a SIM attribute. -[**put-sim-integration**](#put-sim-integration) | **Put** `/sim-integrations/{id}` | Update an existing SIM integration +[**create-sim-integration**](#create-sim-integration) | **Post** `/sim-integrations` | Create new sim integration +[**delete-sim-integration**](#delete-sim-integration) | **Delete** `/sim-integrations/{id}` | Delete a sim integration +[**get-sim-integration**](#get-sim-integration) | **Get** `/sim-integrations/{id}` | Get a sim integration details. +[**get-sim-integrations**](#get-sim-integrations) | **Get** `/sim-integrations` | List the existing sim integrations. +[**patch-before-provisioning-rule**](#patch-before-provisioning-rule) | **Patch** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a sim beforeprovisioningrule attribute. +[**patch-sim-attributes**](#patch-sim-attributes) | **Patch** `/sim-integrations/{id}` | Patch a sim attribute. +[**put-sim-integration**](#put-sim-integration) | **Put** `/sim-integrations/{id}` | Update an existing sim integration ## create-sim-integration @@ -43,7 +43,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create new SIM integration +Create new sim integration Create a new SIM Integrations. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-sim-integration) @@ -140,7 +140,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete a SIM integration +Delete a sim integration Get the details of a SIM integration. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sim-integration) @@ -218,7 +218,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get a SIM integration details. +Get a sim integration details. Get the details of a SIM integration. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integration) @@ -297,7 +297,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List the existing SIM integrations. +List the existing sim integrations. List the existing SIM integrations. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integrations) @@ -370,7 +370,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch a SIM beforeProvisioningRule attribute. +Patch a sim beforeprovisioningrule attribute. Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-before-provisioning-rule) @@ -466,7 +466,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch a SIM attribute. +Patch a sim attribute. Patch a SIM attribute given a JsonPatch object. [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sim-attributes) @@ -562,7 +562,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update an existing SIM integration +Update an existing sim integration Update an existing SIM integration. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-sim-integration) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SODPoliciesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SODPoliciesAPI.md index c750c6737..0aade981c 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/SODPoliciesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SODPoliciesAPI.md @@ -41,27 +41,27 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-sod-policy**](#create-sod-policy) | **Post** `/sod-policies` | Create SOD policy -[**delete-sod-policy**](#delete-sod-policy) | **Delete** `/sod-policies/{id}` | Delete SOD policy by ID -[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **Delete** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**create-sod-policy**](#create-sod-policy) | **Post** `/sod-policies` | Create sod policy +[**delete-sod-policy**](#delete-sod-policy) | **Delete** `/sod-policies/{id}` | Delete sod policy by id +[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **Delete** `/sod-policies/{id}/schedule` | Delete sod policy schedule [**get-custom-violation-report**](#get-custom-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report [**get-default-violation-report**](#get-default-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download` | Download violation report [**get-sod-all-report-run-status**](#get-sod-all-report-run-status) | **Get** `/sod-violation-report` | Get multi-report run task status -[**get-sod-policy**](#get-sod-policy) | **Get** `/sod-policies/{id}` | Get SOD policy by ID -[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **Get** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**get-sod-policy**](#get-sod-policy) | **Get** `/sod-policies/{id}` | Get sod policy by id +[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **Get** `/sod-policies/{id}/schedule` | Get sod policy schedule [**get-sod-violation-report-run-status**](#get-sod-violation-report-run-status) | **Get** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status -[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **Get** `/sod-policies/{id}/violation-report` | Get SOD violation report status -[**list-sod-policies**](#list-sod-policies) | **Get** `/sod-policies` | List SOD policies -[**patch-sod-policy**](#patch-sod-policy) | **Patch** `/sod-policies/{id}` | Patch SOD policy by ID -[**put-policy-schedule**](#put-policy-schedule) | **Put** `/sod-policies/{id}/schedule` | Update SOD Policy schedule -[**put-sod-policy**](#put-sod-policy) | **Put** `/sod-policies/{id}` | Update SOD policy by ID -[**start-evaluate-sod-policy**](#start-evaluate-sod-policy) | **Post** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID +[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **Get** `/sod-policies/{id}/violation-report` | Get sod violation report status +[**list-sod-policies**](#list-sod-policies) | **Get** `/sod-policies` | List sod policies +[**patch-sod-policy**](#patch-sod-policy) | **Patch** `/sod-policies/{id}` | Patch sod policy by id +[**put-policy-schedule**](#put-policy-schedule) | **Put** `/sod-policies/{id}/schedule` | Update sod policy schedule +[**put-sod-policy**](#put-sod-policy) | **Put** `/sod-policies/{id}` | Update sod policy by id +[**start-evaluate-sod-policy**](#start-evaluate-sod-policy) | **Post** `/sod-policies/{id}/evaluate` | Evaluate one policy by id [**start-sod-all-policies-for-org**](#start-sod-all-policies-for-org) | **Post** `/sod-violation-report/run` | Runs all policies for org -[**start-sod-policy**](#start-sod-policy) | **Post** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report +[**start-sod-policy**](#start-sod-policy) | **Post** `/sod-policies/{id}/violation-report/run` | Runs sod policy violation report ## create-sod-policy -Create SOD policy +Create sod policy This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. @@ -184,7 +184,7 @@ func main() { [[Back to top]](#) ## delete-sod-policy -Delete SOD policy by ID +Delete sod policy by id This deletes a specified SOD policy. Requires role of ORG_ADMIN. @@ -252,7 +252,7 @@ func main() { [[Back to top]](#) ## delete-sod-policy-schedule -Delete SOD policy schedule +Delete sod policy schedule This deletes schedule for a specified SOD policy by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sod-policy-schedule) @@ -509,7 +509,7 @@ func main() { [[Back to top]](#) ## get-sod-policy -Get SOD policy by ID +Get sod policy by id This gets specified SOD policy. Requires role of ORG_ADMIN. @@ -576,7 +576,7 @@ func main() { [[Back to top]](#) ## get-sod-policy-schedule -Get SOD policy schedule +Get sod policy schedule This endpoint gets a specified SOD policy's schedule. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-policy-schedule) @@ -708,7 +708,7 @@ func main() { [[Back to top]](#) ## get-sod-violation-report-status -Get SOD violation report status +Get sod violation report status This gets the status for a violation report run task that has already been invoked. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-violation-report-status) @@ -774,7 +774,7 @@ func main() { [[Back to top]](#) ## list-sod-policies -List SOD policies +List sod policies This gets list of all SOD policies. Requires role of ORG_ADMIN @@ -845,7 +845,7 @@ func main() { [[Back to top]](#) ## patch-sod-policy -Patch SOD policy by ID +Patch sod policy by id Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. @@ -920,7 +920,7 @@ func main() { [[Back to top]](#) ## put-policy-schedule -Update SOD Policy schedule +Update sod policy schedule This updates schedule for a specified SOD policy. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-policy-schedule) @@ -1078,7 +1078,7 @@ func main() { [[Back to top]](#) ## put-sod-policy -Update SOD policy by ID +Update sod policy by id This updates a specified SOD policy. Requires role of ORG_ADMIN. @@ -1207,7 +1207,7 @@ func main() { [[Back to top]](#) ## start-evaluate-sod-policy -Evaluate one policy by ID +Evaluate one policy by id Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/start-evaluate-sod-policy) @@ -1337,7 +1337,7 @@ func main() { [[Back to top]](#) ## start-sod-policy -Runs SOD policy violation report +Runs sod policy violation report This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. [API Spec](https://developer.sailpoint.com/docs/api/v2024/start-sod-policy) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SODViolationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SODViolationsAPI.md index 592c3686d..5c0b8a741 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/SODViolationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SODViolationsAPI.md @@ -33,12 +33,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**start-predict-sod-violations**](#start-predict-sod-violations) | **Post** `/sod-violations/predict` | Predict SOD violations for identity. -[**start-violation-check**](#start-violation-check) | **Post** `/sod-violations/check` | Check SOD violations +[**start-predict-sod-violations**](#start-predict-sod-violations) | **Post** `/sod-violations/predict` | Predict sod violations for identity. +[**start-violation-check**](#start-violation-check) | **Post** `/sod-violations/check` | Check sod violations ## start-predict-sod-violations -Predict SOD violations for identity. +Predict sod violations for identity. This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. [API Spec](https://developer.sailpoint.com/docs/api/v2024/start-predict-sod-violations) @@ -116,7 +116,7 @@ func main() { [[Back to top]](#) ## start-violation-check -Check SOD violations +Check sod violations This API initiates a SOD policy verification asynchronously. [API Spec](https://developer.sailpoint.com/docs/api/v2024/start-violation-check) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SPConfigAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SPConfigAPI.md index 2562fe8b5..d31a0a07b 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/SPConfigAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SPConfigAPI.md @@ -21,7 +21,7 @@ Method | HTTP request | Description [**get-sp-config-import**](#get-sp-config-import) | **Get** `/sp-config/import/{id}/download` | Download import job result [**get-sp-config-import-status**](#get-sp-config-import-status) | **Get** `/sp-config/import/{id}` | Get import job status [**import-sp-config**](#import-sp-config) | **Post** `/sp-config/import` | Initiates configuration objects import job -[**list-sp-config-objects**](#list-sp-config-objects) | **Get** `/sp-config/config-objects` | List Config Objects +[**list-sp-config-objects**](#list-sp-config-objects) | **Get** `/sp-config/config-objects` | List config objects ## export-sp-config @@ -445,7 +445,7 @@ func main() { [[Back to top]](#) ## list-sp-config-objects -List Config Objects +List config objects Get a list of object configurations that the tenant export/import service knows. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sp-config-objects) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SavedSearchAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SavedSearchAPI.md index 464aa3c30..52b9e46ed 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/SavedSearchAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SavedSearchAPI.md @@ -26,10 +26,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-saved-search**](#create-saved-search) | **Post** `/saved-searches` | Create a saved search -[**delete-saved-search**](#delete-saved-search) | **Delete** `/saved-searches/{id}` | Delete document by ID -[**execute-saved-search**](#execute-saved-search) | **Post** `/saved-searches/{id}/execute` | Execute a saved search by ID -[**get-saved-search**](#get-saved-search) | **Get** `/saved-searches/{id}` | Return saved search by ID -[**list-saved-searches**](#list-saved-searches) | **Get** `/saved-searches` | A list of Saved Searches +[**delete-saved-search**](#delete-saved-search) | **Delete** `/saved-searches/{id}` | Delete document by id +[**execute-saved-search**](#execute-saved-search) | **Post** `/saved-searches/{id}/execute` | Execute a saved search by id +[**get-saved-search**](#get-saved-search) | **Get** `/saved-searches/{id}` | Return saved search by id +[**list-saved-searches**](#list-saved-searches) | **Get** `/saved-searches` | A list of saved searches [**put-saved-search**](#put-saved-search) | **Put** `/saved-searches/{id}` | Updates an existing saved search @@ -102,7 +102,7 @@ func main() { [[Back to top]](#) ## delete-saved-search -Delete document by ID +Delete document by id Deletes the specified saved search. @@ -168,7 +168,7 @@ func main() { [[Back to top]](#) ## execute-saved-search -Execute a saved search by ID +Execute a saved search by id Executes the specified saved search. @@ -251,7 +251,7 @@ func main() { [[Back to top]](#) ## get-saved-search -Return saved search by ID +Return saved search by id Returns the specified saved search. @@ -318,7 +318,7 @@ func main() { [[Back to top]](#) ## list-saved-searches -A list of Saved Searches +A list of saved searches Returns a list of saved searches. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ScheduledSearchAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ScheduledSearchAPI.md index dbf134af7..3c53457b6 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/ScheduledSearchAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ScheduledSearchAPI.md @@ -42,11 +42,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-scheduled-search**](#create-scheduled-search) | **Post** `/scheduled-searches` | Create a new scheduled search -[**delete-scheduled-search**](#delete-scheduled-search) | **Delete** `/scheduled-searches/{id}` | Delete a Scheduled Search -[**get-scheduled-search**](#get-scheduled-search) | **Get** `/scheduled-searches/{id}` | Get a Scheduled Search +[**delete-scheduled-search**](#delete-scheduled-search) | **Delete** `/scheduled-searches/{id}` | Delete a scheduled search +[**get-scheduled-search**](#get-scheduled-search) | **Get** `/scheduled-searches/{id}` | Get a scheduled search [**list-scheduled-search**](#list-scheduled-search) | **Get** `/scheduled-searches` | List scheduled searches -[**unsubscribe-scheduled-search**](#unsubscribe-scheduled-search) | **Post** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search -[**update-scheduled-search**](#update-scheduled-search) | **Put** `/scheduled-searches/{id}` | Update an existing Scheduled Search +[**unsubscribe-scheduled-search**](#unsubscribe-scheduled-search) | **Post** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from scheduled search +[**update-scheduled-search**](#update-scheduled-search) | **Put** `/scheduled-searches/{id}` | Update an existing scheduled search ## create-scheduled-search @@ -118,7 +118,7 @@ func main() { [[Back to top]](#) ## delete-scheduled-search -Delete a Scheduled Search +Delete a scheduled search Deletes the specified scheduled search. @@ -184,7 +184,7 @@ func main() { [[Back to top]](#) ## get-scheduled-search -Get a Scheduled Search +Get a scheduled search Returns the specified scheduled search. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-scheduled-search) @@ -319,7 +319,7 @@ func main() { [[Back to top]](#) ## unsubscribe-scheduled-search -Unsubscribe a recipient from Scheduled Search +Unsubscribe a recipient from scheduled search Unsubscribes a recipient from the specified scheduled search. @@ -395,7 +395,7 @@ func main() { [[Back to top]](#) ## update-scheduled-search -Update an existing Scheduled Search +Update an existing scheduled search Updates an existing scheduled search. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SearchAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SearchAPI.md index 699ebb31f..837f3b22f 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/SearchAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SearchAPI.md @@ -38,14 +38,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**search-aggregate**](#search-aggregate) | **Post** `/search/aggregate` | Perform a Search Query Aggregation -[**search-count**](#search-count) | **Post** `/search/count` | Count Documents Satisfying a Query -[**search-get**](#search-get) | **Get** `/search/{index}/{id}` | Get a Document by ID -[**search-post**](#search-post) | **Post** `/search` | Perform Search +[**search-aggregate**](#search-aggregate) | **Post** `/search/aggregate` | Perform a search query aggregation +[**search-count**](#search-count) | **Post** `/search/count` | Count documents satisfying a query +[**search-get**](#search-get) | **Get** `/search/{index}/{id}` | Get a document by id +[**search-post**](#search-post) | **Post** `/search` | Perform search ## search-aggregate -Perform a Search Query Aggregation +Perform a search query aggregation Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. [API Spec](https://developer.sailpoint.com/docs/api/v2024/search-aggregate) @@ -234,7 +234,7 @@ func main() { [[Back to top]](#) ## search-count -Count Documents Satisfying a Query +Count documents satisfying a query Performs a search with a provided query and returns the count of results in the X-Total-Count header. [API Spec](https://developer.sailpoint.com/docs/api/v2024/search-count) @@ -416,7 +416,7 @@ func main() { [[Back to top]](#) ## search-get -Get a Document by ID +Get a document by id Fetches a single document from the specified index, using the specified document ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/search-get) @@ -485,7 +485,7 @@ func main() { [[Back to top]](#) ## search-post -Perform Search +Perform search Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. [API Spec](https://developer.sailpoint.com/docs/api/v2024/search-post) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SearchAttributeConfigurationAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SearchAttributeConfigurationAPI.md index 878ba2c65..c50c086cd 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/SearchAttributeConfigurationAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SearchAttributeConfigurationAPI.md @@ -33,11 +33,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-search-attribute-config**](#create-search-attribute-config) | **Post** `/accounts/search-attribute-config` | Create Extended Search Attributes -[**delete-search-attribute-config**](#delete-search-attribute-config) | **Delete** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute -[**get-search-attribute-config**](#get-search-attribute-config) | **Get** `/accounts/search-attribute-config` | List Extended Search Attributes -[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **Get** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute -[**patch-search-attribute-config**](#patch-search-attribute-config) | **Patch** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute +[**create-search-attribute-config**](#create-search-attribute-config) | **Post** `/accounts/search-attribute-config` | Create extended search attributes +[**delete-search-attribute-config**](#delete-search-attribute-config) | **Delete** `/accounts/search-attribute-config/{name}` | Delete extended search attribute +[**get-search-attribute-config**](#get-search-attribute-config) | **Get** `/accounts/search-attribute-config` | List extended search attributes +[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **Get** `/accounts/search-attribute-config/{name}` | Get extended search attribute +[**patch-search-attribute-config**](#patch-search-attribute-config) | **Patch** `/accounts/search-attribute-config/{name}` | Update extended search attribute ## create-search-attribute-config @@ -52,7 +52,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create Extended Search Attributes +Create extended search attributes Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** @@ -140,7 +140,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Extended Search Attribute +Delete extended search attribute Delete an extended attribute configuration by name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-search-attribute-config) @@ -218,7 +218,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Extended Search Attributes +List extended search attributes Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-search-attribute-config) @@ -295,7 +295,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Extended Search Attribute +Get extended search attribute Get an extended attribute configuration by name. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-single-search-attribute-config) @@ -374,7 +374,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Extended Search Attribute +Update extended search attribute Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SegmentsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SegmentsAPI.md index 3e6a749b9..ccaa25888 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/SegmentsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SegmentsAPI.md @@ -32,15 +32,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-segment**](#create-segment) | **Post** `/segments` | Create Segment -[**delete-segment**](#delete-segment) | **Delete** `/segments/{id}` | Delete Segment by ID -[**get-segment**](#get-segment) | **Get** `/segments/{id}` | Get Segment by ID -[**list-segments**](#list-segments) | **Get** `/segments` | List Segments -[**patch-segment**](#patch-segment) | **Patch** `/segments/{id}` | Update Segment +[**create-segment**](#create-segment) | **Post** `/segments` | Create segment +[**delete-segment**](#delete-segment) | **Delete** `/segments/{id}` | Delete segment by id +[**get-segment**](#get-segment) | **Get** `/segments/{id}` | Get segment by id +[**list-segments**](#list-segments) | **Get** `/segments` | List segments +[**patch-segment**](#patch-segment) | **Patch** `/segments/{id}` | Update segment ## create-segment -Create Segment +Create segment This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. @@ -131,7 +131,7 @@ func main() { [[Back to top]](#) ## delete-segment -Delete Segment by ID +Delete segment by id This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. @@ -197,7 +197,7 @@ func main() { [[Back to top]](#) ## get-segment -Get Segment by ID +Get segment by id This API returns the segment specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-segment) @@ -263,7 +263,7 @@ func main() { [[Back to top]](#) ## list-segments -List Segments +List segments This API returns a list of all segments. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-segments) @@ -329,7 +329,7 @@ func main() { [[Back to top]](#) ## patch-segment -Update Segment +Update segment Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ServiceDeskIntegrationAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ServiceDeskIntegrationAPI.md index 10c1bb5c3..b72d3d1c8 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/ServiceDeskIntegrationAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ServiceDeskIntegrationAPI.md @@ -39,20 +39,20 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-service-desk-integration**](#create-service-desk-integration) | **Post** `/service-desk-integrations` | Create new Service Desk integration -[**delete-service-desk-integration**](#delete-service-desk-integration) | **Delete** `/service-desk-integrations/{id}` | Delete a Service Desk integration -[**get-service-desk-integration**](#get-service-desk-integration) | **Get** `/service-desk-integrations/{id}` | Get a Service Desk integration -[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **Get** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName -[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **Get** `/service-desk-integrations/types` | List Service Desk integration types -[**get-service-desk-integrations**](#get-service-desk-integrations) | **Get** `/service-desk-integrations` | List existing Service Desk integrations +[**create-service-desk-integration**](#create-service-desk-integration) | **Post** `/service-desk-integrations` | Create new service desk integration +[**delete-service-desk-integration**](#delete-service-desk-integration) | **Delete** `/service-desk-integrations/{id}` | Delete a service desk integration +[**get-service-desk-integration**](#get-service-desk-integration) | **Get** `/service-desk-integrations/{id}` | Get a service desk integration +[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **Get** `/service-desk-integrations/templates/{scriptName}` | Service desk integration template by scriptname +[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **Get** `/service-desk-integrations/types` | List service desk integration types +[**get-service-desk-integrations**](#get-service-desk-integrations) | **Get** `/service-desk-integrations` | List existing service desk integrations [**get-status-check-details**](#get-status-check-details) | **Get** `/service-desk-integrations/status-check-configuration` | Get the time check configuration -[**patch-service-desk-integration**](#patch-service-desk-integration) | **Patch** `/service-desk-integrations/{id}` | Patch a Service Desk Integration -[**put-service-desk-integration**](#put-service-desk-integration) | **Put** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**patch-service-desk-integration**](#patch-service-desk-integration) | **Patch** `/service-desk-integrations/{id}` | Patch a service desk integration +[**put-service-desk-integration**](#put-service-desk-integration) | **Put** `/service-desk-integrations/{id}` | Update a service desk integration [**update-status-check-details**](#update-status-check-details) | **Put** `/service-desk-integrations/status-check-configuration` | Update the time check configuration ## create-service-desk-integration -Create new Service Desk integration +Create new service desk integration Create a new Service Desk integration. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-service-desk-integration) @@ -152,7 +152,7 @@ func main() { [[Back to top]](#) ## delete-service-desk-integration -Delete a Service Desk integration +Delete a service desk integration Delete an existing Service Desk integration by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-service-desk-integration) @@ -217,7 +217,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integration -Get a Service Desk integration +Get a service desk integration Get an existing Service Desk integration by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integration) @@ -283,7 +283,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integration-template -Service Desk integration template by scriptName +Service desk integration template by scriptname This API endpoint returns an existing Service Desk integration template by scriptName. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integration-template) @@ -349,7 +349,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integration-types -List Service Desk integration types +List service desk integration types This API endpoint returns the current list of supported Service Desk integration types. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integration-types) @@ -406,7 +406,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integrations -List existing Service Desk integrations +List existing service desk integrations Get a list of Service Desk integration objects. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integrations) @@ -533,7 +533,7 @@ func main() { [[Back to top]](#) ## patch-service-desk-integration -Patch a Service Desk Integration +Patch a service desk integration Update an existing Service Desk integration by ID with a PATCH request. [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-service-desk-integration) @@ -606,7 +606,7 @@ func main() { [[Back to top]](#) ## put-service-desk-integration -Update a Service Desk integration +Update a service desk integration Update an existing Service Desk integration by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-service-desk-integration) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SourcesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SourcesAPI.md index dda9db26e..efede0332 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/SourcesAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SourcesAPI.md @@ -72,60 +72,60 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-provisioning-policy**](#create-provisioning-policy) | **Post** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy -[**create-source**](#create-source) | **Post** `/sources` | Creates a source in IdentityNow. -[**create-source-schedule**](#create-source-schedule) | **Post** `/sources/{sourceId}/schedules` | Create Schedule on Source -[**create-source-schema**](#create-source-schema) | **Post** `/sources/{sourceId}/schemas` | Create Schema on Source -[**delete-accounts-async**](#delete-accounts-async) | **Post** `/sources/{id}/remove-accounts` | Remove All Accounts in a Source -[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **Delete** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration -[**delete-provisioning-policy**](#delete-provisioning-policy) | **Delete** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType -[**delete-source**](#delete-source) | **Delete** `/sources/{id}` | Delete Source by ID -[**delete-source-schedule**](#delete-source-schedule) | **Delete** `/sources/{sourceId}/schedules/{scheduleType}` | Delete Source Schedule by type. -[**delete-source-schema**](#delete-source-schema) | **Delete** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**create-provisioning-policy**](#create-provisioning-policy) | **Post** `/sources/{sourceId}/provisioning-policies` | Create provisioning policy +[**create-source**](#create-source) | **Post** `/sources` | Creates a source in identitynow. +[**create-source-schedule**](#create-source-schedule) | **Post** `/sources/{sourceId}/schedules` | Create schedule on source +[**create-source-schema**](#create-source-schema) | **Post** `/sources/{sourceId}/schemas` | Create schema on source +[**delete-accounts-async**](#delete-accounts-async) | **Post** `/sources/{id}/remove-accounts` | Remove all accounts in a source +[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **Delete** `/sources/{sourceId}/native-change-detection-config` | Delete native change detection configuration +[**delete-provisioning-policy**](#delete-provisioning-policy) | **Delete** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype +[**delete-source**](#delete-source) | **Delete** `/sources/{id}` | Delete source by id +[**delete-source-schedule**](#delete-source-schedule) | **Delete** `/sources/{sourceId}/schedules/{scheduleType}` | Delete source schedule by type. +[**delete-source-schema**](#delete-source-schema) | **Delete** `/sources/{sourceId}/schemas/{schemaId}` | Delete source schema by id [**get-accounts-schema**](#get-accounts-schema) | **Get** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template -[**get-correlation-config**](#get-correlation-config) | **Get** `/sources/{id}/correlation-config` | Get Source Correlation Configuration +[**get-correlation-config**](#get-correlation-config) | **Get** `/sources/{id}/correlation-config` | Get source correlation configuration [**get-entitlements-schema**](#get-entitlements-schema) | **Get** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template -[**get-native-change-detection-config**](#get-native-change-detection-config) | **Get** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration -[**get-provisioning-policy**](#get-provisioning-policy) | **Get** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType -[**get-source**](#get-source) | **Get** `/sources/{id}` | Get Source by ID -[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **Get** `/sources/{id}/attribute-sync-config` | Attribute Sync Config +[**get-native-change-detection-config**](#get-native-change-detection-config) | **Get** `/sources/{sourceId}/native-change-detection-config` | Native change detection configuration +[**get-provisioning-policy**](#get-provisioning-policy) | **Get** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype +[**get-source**](#get-source) | **Get** `/sources/{id}` | Get source by id +[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **Get** `/sources/{id}/attribute-sync-config` | Attribute sync config [**get-source-config**](#get-source-config) | **Get** `/sources/{id}/connectors/source-config` | Gets source config with language-translations -[**get-source-connections**](#get-source-connections) | **Get** `/sources/{sourceId}/connections` | Get Source Connections by ID -[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **Get** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration +[**get-source-connections**](#get-source-connections) | **Get** `/sources/{sourceId}/connections` | Get source connections by id +[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **Get** `/sources/{id}/entitlement-request-config` | Get source entitlement request configuration [**get-source-health**](#get-source-health) | **Get** `/sources/{sourceId}/source-health` | Fetches source health by id -[**get-source-schedule**](#get-source-schedule) | **Get** `/sources/{sourceId}/schedules/{scheduleType}` | Get Source Schedule by Type -[**get-source-schedules**](#get-source-schedules) | **Get** `/sources/{sourceId}/schedules` | List Schedules on Source -[**get-source-schema**](#get-source-schema) | **Get** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID -[**get-source-schemas**](#get-source-schemas) | **Get** `/sources/{sourceId}/schemas` | List Schemas on Source -[**import-accounts**](#import-accounts) | **Post** `/sources/{id}/load-accounts` | Account Aggregation +[**get-source-schedule**](#get-source-schedule) | **Get** `/sources/{sourceId}/schedules/{scheduleType}` | Get source schedule by type +[**get-source-schedules**](#get-source-schedules) | **Get** `/sources/{sourceId}/schedules` | List schedules on source +[**get-source-schema**](#get-source-schema) | **Get** `/sources/{sourceId}/schemas/{schemaId}` | Get source schema by id +[**get-source-schemas**](#get-source-schemas) | **Get** `/sources/{sourceId}/schemas` | List schemas on source +[**import-accounts**](#import-accounts) | **Post** `/sources/{id}/load-accounts` | Account aggregation [**import-accounts-schema**](#import-accounts-schema) | **Post** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template [**import-connector-file**](#import-connector-file) | **Post** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source [**import-entitlements-schema**](#import-entitlements-schema) | **Post** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template -[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **Post** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts -[**list-provisioning-policies**](#list-provisioning-policies) | **Get** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies -[**list-sources**](#list-sources) | **Get** `/sources` | Lists all sources in IdentityNow. +[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **Post** `/sources/{id}/load-uncorrelated-accounts` | Process uncorrelated accounts +[**list-provisioning-policies**](#list-provisioning-policies) | **Get** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies +[**list-sources**](#list-sources) | **Get** `/sources` | Lists all sources in identitynow. [**ping-cluster**](#ping-cluster) | **Post** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector -[**put-correlation-config**](#put-correlation-config) | **Put** `/sources/{id}/correlation-config` | Update Source Correlation Configuration -[**put-native-change-detection-config**](#put-native-change-detection-config) | **Put** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration -[**put-provisioning-policy**](#put-provisioning-policy) | **Put** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType -[**put-source**](#put-source) | **Put** `/sources/{id}` | Update Source (Full) -[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **Put** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config -[**put-source-schema**](#put-source-schema) | **Put** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**put-correlation-config**](#put-correlation-config) | **Put** `/sources/{id}/correlation-config` | Update source correlation configuration +[**put-native-change-detection-config**](#put-native-change-detection-config) | **Put** `/sources/{sourceId}/native-change-detection-config` | Update native change detection configuration +[**put-provisioning-policy**](#put-provisioning-policy) | **Put** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype +[**put-source**](#put-source) | **Put** `/sources/{id}` | Update source (full) +[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **Put** `/sources/{id}/attribute-sync-config` | Update attribute sync config +[**put-source-schema**](#put-source-schema) | **Put** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (full) [**search-resource-objects**](#search-resource-objects) | **Post** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects [**sync-attributes-for-source**](#sync-attributes-for-source) | **Post** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes. [**test-source-configuration**](#test-source-configuration) | **Post** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector [**test-source-connection**](#test-source-connection) | **Post** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector. -[**update-password-policy-holders**](#update-password-policy-holders) | **Patch** `/sources/{sourceId}/password-policies` | Update Password Policy -[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **Post** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies -[**update-provisioning-policy**](#update-provisioning-policy) | **Patch** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy -[**update-source**](#update-source) | **Patch** `/sources/{id}` | Update Source (Partial) -[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **Put** `/sources/{id}/entitlement-request-config` | Update Source Entitlement Request Configuration -[**update-source-schedule**](#update-source-schedule) | **Patch** `/sources/{sourceId}/schedules/{scheduleType}` | Update Source Schedule (Partial) -[**update-source-schema**](#update-source-schema) | **Patch** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) +[**update-password-policy-holders**](#update-password-policy-holders) | **Patch** `/sources/{sourceId}/password-policies` | Update password policy +[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **Post** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies +[**update-provisioning-policy**](#update-provisioning-policy) | **Patch** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy +[**update-source**](#update-source) | **Patch** `/sources/{id}` | Update source (partial) +[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **Put** `/sources/{id}/entitlement-request-config` | Update source entitlement request configuration +[**update-source-schedule**](#update-source-schedule) | **Patch** `/sources/{sourceId}/schedules/{scheduleType}` | Update source schedule (partial) +[**update-source-schema**](#update-source-schema) | **Patch** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (partial) ## create-provisioning-policy -Create Provisioning Policy +Create provisioning policy This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. @@ -239,7 +239,7 @@ func main() { [[Back to top]](#) ## create-source -Creates a source in IdentityNow. +Creates a source in identitynow. This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source) @@ -390,7 +390,7 @@ func main() { [[Back to top]](#) ## create-source-schedule -Create Schedule on Source +Create schedule on source Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). @@ -464,7 +464,7 @@ func main() { [[Back to top]](#) ## create-source-schema -Create Schema on Source +Create schema on source Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). @@ -582,7 +582,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Remove All Accounts in a Source +Remove all accounts in a source Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: @@ -667,7 +667,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Native Change Detection Configuration +Delete native change detection configuration Deletes the native change detection configuration for the source specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-native-change-detection-config) @@ -734,7 +734,7 @@ func main() { [[Back to top]](#) ## delete-provisioning-policy -Delete Provisioning Policy by UsageType +Delete provisioning policy by usagetype Deletes the provisioning policy with the specified usage on an application. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-provisioning-policy) @@ -802,7 +802,7 @@ func main() { [[Back to top]](#) ## delete-source -Delete Source by ID +Delete source by id Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` @@ -869,7 +869,7 @@ func main() { [[Back to top]](#) ## delete-source-schedule -Delete Source Schedule by type. +Delete source schedule by type. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-schedule) @@ -937,7 +937,7 @@ func main() { [[Back to top]](#) ## delete-source-schema -Delete Source Schema by ID +Delete source schema by id [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-schema) @@ -1071,7 +1071,7 @@ func main() { [[Back to top]](#) ## get-correlation-config -Get Source Correlation Configuration +Get source correlation configuration This API returns the existing correlation configuration for a source specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-correlation-config) @@ -1217,7 +1217,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Native Change Detection Configuration +Native change detection configuration This API returns the existing native change detection configuration for a source specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-native-change-detection-config) @@ -1285,7 +1285,7 @@ func main() { [[Back to top]](#) ## get-provisioning-policy -Get Provisioning Policy by UsageType +Get provisioning policy by usagetype This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-provisioning-policy) @@ -1354,7 +1354,7 @@ func main() { [[Back to top]](#) ## get-source -Get Source by ID +Get source by id Use this API to get a source by a specified ID in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source) @@ -1431,7 +1431,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Attribute Sync Config +Attribute sync config This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-attr-sync-config) @@ -1567,7 +1567,7 @@ func main() { [[Back to top]](#) ## get-source-connections -Get Source Connections by ID +Get source connections by id Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-connections) @@ -1644,7 +1644,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Source Entitlement Request Configuration +Get source entitlement request configuration This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. @@ -1776,7 +1776,7 @@ func main() { [[Back to top]](#) ## get-source-schedule -Get Source Schedule by Type +Get source schedule by type Get the source schedule by type in Identity Security Cloud (ISC). @@ -1846,7 +1846,7 @@ func main() { [[Back to top]](#) ## get-source-schedules -List Schedules on Source +List schedules on source Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. @@ -1920,7 +1920,7 @@ func main() { [[Back to top]](#) ## get-source-schema -Get Source Schema by ID +Get source schema by id Get the Source Schema by ID in IdentityNow. @@ -1990,7 +1990,7 @@ func main() { [[Back to top]](#) ## get-source-schemas -List Schemas on Source +List schemas on source Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schemas) @@ -2071,7 +2071,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Account Aggregation +Account aggregation Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. @@ -2374,7 +2374,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Process Uncorrelated Accounts +Process uncorrelated accounts File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` [API Spec](https://developer.sailpoint.com/docs/api/v2024/import-uncorrelated-accounts) @@ -2444,7 +2444,7 @@ func main() { [[Back to top]](#) ## list-provisioning-policies -Lists ProvisioningPolicies +Lists provisioningpolicies This end-point lists all the ProvisioningPolicies in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-provisioning-policies) @@ -2510,7 +2510,7 @@ func main() { [[Back to top]](#) ## list-sources -Lists all sources in IdentityNow. +Lists all sources in identitynow. This end-point lists all the sources in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sources) @@ -2650,7 +2650,7 @@ func main() { [[Back to top]](#) ## put-correlation-config -Update Source Correlation Configuration +Update source correlation configuration Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-correlation-config) @@ -2754,7 +2754,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Native Change Detection Configuration +Update native change detection configuration Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-native-change-detection-config) @@ -2836,7 +2836,7 @@ func main() { [[Back to top]](#) ## put-provisioning-policy -Update Provisioning Policy by UsageType +Update provisioning policy by usagetype This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. @@ -2953,7 +2953,7 @@ func main() { [[Back to top]](#) ## put-source -Update Source (Full) +Update source (full) Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: @@ -3131,7 +3131,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Attribute Sync Config +Update attribute sync config Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. @@ -3224,7 +3224,7 @@ func main() { [[Back to top]](#) ## put-source-schema -Update Source Schema (Full) +Update source schema (full) This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id @@ -3630,7 +3630,7 @@ func main() { [[Back to top]](#) ## update-password-policy-holders -Update Password Policy +Update password policy This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. @@ -3705,7 +3705,7 @@ func main() { [[Back to top]](#) ## update-provisioning-policies-in-bulk -Bulk Update Provisioning Policies +Bulk update provisioning policies This end-point updates a list of provisioning policies on the specified source in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v2024/update-provisioning-policies-in-bulk) @@ -3778,7 +3778,7 @@ func main() { [[Back to top]](#) ## update-provisioning-policy -Partial update of Provisioning Policy +Partial update of provisioning policy This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. @@ -3856,7 +3856,7 @@ func main() { [[Back to top]](#) ## update-source -Update Source (Partial) +Update source (partial) Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. @@ -3955,7 +3955,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Source Entitlement Request Configuration +Update source entitlement request configuration This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. @@ -4050,7 +4050,7 @@ func main() { [[Back to top]](#) ## update-source-schedule -Update Source Schedule (Partial) +Update source schedule (partial) Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: @@ -4131,7 +4131,7 @@ func main() { [[Back to top]](#) ## update-source-schema -Update Source Schema (Partial) +Update source schema (partial) Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SuggestedEntitlementDescriptionAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SuggestedEntitlementDescriptionAPI.md index 83e2f530d..710785661 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/SuggestedEntitlementDescriptionAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SuggestedEntitlementDescriptionAPI.md @@ -18,17 +18,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-sed-batch-stats**](#get-sed-batch-stats) | **Get** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request -[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List Sed Batch Request -[**list-seds**](#list-seds) | **Get** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions -[**patch-sed**](#patch-sed) | **Patch** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description -[**submit-sed-approval**](#submit-sed-approval) | **Post** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request -[**submit-sed-assignment**](#submit-sed-assignment) | **Post** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request -[**submit-sed-batch-request**](#submit-sed-batch-request) | **Post** `/suggested-entitlement-description-batches` | Submit Sed Batch Request +[**get-sed-batch-stats**](#get-sed-batch-stats) | **Get** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit sed batch stats request +[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List sed batch request +[**list-seds**](#list-seds) | **Get** `/suggested-entitlement-descriptions` | List suggested entitlement descriptions +[**patch-sed**](#patch-sed) | **Patch** `/suggested-entitlement-descriptions` | Patch suggested entitlement description +[**submit-sed-approval**](#submit-sed-approval) | **Post** `/suggested-entitlement-description-approvals` | Submit bulk approval request +[**submit-sed-assignment**](#submit-sed-assignment) | **Post** `/suggested-entitlement-description-assignments` | Submit sed assignment request +[**submit-sed-batch-request**](#submit-sed-batch-request) | **Post** `/suggested-entitlement-description-batches` | Submit sed batch request ## get-sed-batch-stats -Submit Sed Batch Stats Request +Submit sed batch stats request 'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats @@ -98,7 +98,7 @@ func main() { [[Back to top]](#) ## get-sed-batches -List Sed Batch Request +List sed batch request List Sed Batches. API responses with Sed Batch Status @@ -156,7 +156,7 @@ func main() { [[Back to top]](#) ## list-seds -List Suggested Entitlement Descriptions +List suggested entitlement descriptions List of Suggested Entitlement Descriptions (SED) SED field descriptions: @@ -246,7 +246,7 @@ func main() { [[Back to top]](#) ## patch-sed -Patch Suggested Entitlement Description +Patch suggested entitlement description Patch Suggested Entitlement Description [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sed) @@ -319,7 +319,7 @@ func main() { [[Back to top]](#) ## submit-sed-approval -Submit Bulk Approval Request +Submit bulk approval request Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status @@ -387,7 +387,7 @@ func main() { [[Back to top]](#) ## submit-sed-assignment -Submit Sed Assignment Request +Submit sed assignment request Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together @@ -461,7 +461,7 @@ func main() { [[Back to top]](#) ## submit-sed-batch-request -Submit Sed Batch Request +Submit sed batch request Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/TaggedObjectsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/TaggedObjectsAPI.md index d9983eb1d..7ffc943d1 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/TaggedObjectsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/TaggedObjectsAPI.md @@ -68,18 +68,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**delete-tagged-object**](#delete-tagged-object) | **Delete** `/tagged-objects/{type}/{id}` | Delete Object Tags -[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **Post** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects -[**get-tagged-object**](#get-tagged-object) | **Get** `/tagged-objects/{type}/{id}` | Get Tagged Object -[**list-tagged-objects**](#list-tagged-objects) | **Get** `/tagged-objects` | List Tagged Objects -[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **Get** `/tagged-objects/{type}` | List Tagged Objects by Type -[**put-tagged-object**](#put-tagged-object) | **Put** `/tagged-objects/{type}/{id}` | Update Tagged Object -[**set-tag-to-object**](#set-tag-to-object) | **Post** `/tagged-objects` | Add Tag to Object -[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **Post** `/tagged-objects/bulk-add` | Tag Multiple Objects +[**delete-tagged-object**](#delete-tagged-object) | **Delete** `/tagged-objects/{type}/{id}` | Delete object tags +[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **Post** `/tagged-objects/bulk-remove` | Remove tags from multiple objects +[**get-tagged-object**](#get-tagged-object) | **Get** `/tagged-objects/{type}/{id}` | Get tagged object +[**list-tagged-objects**](#list-tagged-objects) | **Get** `/tagged-objects` | List tagged objects +[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **Get** `/tagged-objects/{type}` | List tagged objects by type +[**put-tagged-object**](#put-tagged-object) | **Put** `/tagged-objects/{type}/{id}` | Update tagged object +[**set-tag-to-object**](#set-tag-to-object) | **Post** `/tagged-objects` | Add tag to object +[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **Post** `/tagged-objects/bulk-add` | Tag multiple objects ## delete-tagged-object -Delete Object Tags +Delete object tags Delete all tags from a tagged object. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-tagged-object) @@ -147,7 +147,7 @@ func main() { [[Back to top]](#) ## delete-tags-to-many-object -Remove Tags from Multiple Objects +Remove tags from multiple objects This API removes tags from multiple objects. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-tags-to-many-object) @@ -224,7 +224,7 @@ func main() { [[Back to top]](#) ## get-tagged-object -Get Tagged Object +Get tagged object This gets a tagged object for the specified type. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tagged-object) @@ -293,7 +293,7 @@ func main() { [[Back to top]](#) ## list-tagged-objects -List Tagged Objects +List tagged objects This API returns a list of all tagged objects. Any authenticated token may be used to call this API. @@ -363,7 +363,7 @@ func main() { [[Back to top]](#) ## list-tagged-objects-by-type -List Tagged Objects by Type +List tagged objects by type This API returns a list of all tagged objects by type. Any authenticated token may be used to call this API. @@ -439,7 +439,7 @@ func main() { [[Back to top]](#) ## put-tagged-object -Update Tagged Object +Update tagged object This updates a tagged object for the specified type. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-tagged-object) @@ -522,7 +522,7 @@ func main() { [[Back to top]](#) ## set-tag-to-object -Add Tag to Object +Add tag to object This adds a tag to an object. Any authenticated token may be used to call this API. @@ -597,7 +597,7 @@ func main() { [[Back to top]](#) ## set-tags-to-many-objects -Tag Multiple Objects +Tag multiple objects This API adds tags to multiple objects. [API Spec](https://developer.sailpoint.com/docs/api/v2024/set-tags-to-many-objects) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/TaskManagementAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/TaskManagementAPI.md index 1c7b89e27..d63239217 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/TaskManagementAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/TaskManagementAPI.md @@ -15,11 +15,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-pending-task-headers**](#get-pending-task-headers) | **Head** `/task-status/pending-tasks` | Retrieve Pending Task List Headers -[**get-pending-tasks**](#get-pending-tasks) | **Get** `/task-status/pending-tasks` | Retrieve Pending Task Status List -[**get-task-status**](#get-task-status) | **Get** `/task-status/{id}` | Get Task Status by ID -[**get-task-status-list**](#get-task-status-list) | **Get** `/task-status` | Retrieve Task Status List -[**update-task-status**](#update-task-status) | **Patch** `/task-status/{id}` | Update Task Status by ID +[**get-pending-task-headers**](#get-pending-task-headers) | **Head** `/task-status/pending-tasks` | Retrieve pending task list headers +[**get-pending-tasks**](#get-pending-tasks) | **Get** `/task-status/pending-tasks` | Retrieve pending task status list +[**get-task-status**](#get-task-status) | **Get** `/task-status/{id}` | Get task status by id +[**get-task-status-list**](#get-task-status-list) | **Get** `/task-status` | Retrieve task status list +[**update-task-status**](#update-task-status) | **Patch** `/task-status/{id}` | Update task status by id ## get-pending-task-headers @@ -34,7 +34,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Retrieve Pending Task List Headers +Retrieve pending task list headers Responds with headers only for list of task statuses for pending tasks. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-task-headers) @@ -112,7 +112,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Retrieve Pending Task Status List +Retrieve pending task status list Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) @@ -191,7 +191,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Task Status by ID +Get task status by id Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-task-status) @@ -270,7 +270,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Retrieve Task Status List +Retrieve task status list Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. @@ -354,7 +354,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Task Status by ID +Update task status by id Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. [API Spec](https://developer.sailpoint.com/docs/api/v2024/update-task-status) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/TenantAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/TenantAPI.md index 874107068..d09473dc2 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/TenantAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/TenantAPI.md @@ -15,11 +15,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-tenant**](#get-tenant) | **Get** `/tenant` | Get Tenant Information. +[**get-tenant**](#get-tenant) | **Get** `/tenant` | Get tenant information. ## get-tenant -Get Tenant Information. +Get tenant information. This rest endpoint can be used to retrieve tenant details. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/TransformsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/TransformsAPI.md index 8ac25d56a..0404bcd3d 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/TransformsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/TransformsAPI.md @@ -22,7 +22,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create-transform**](#create-transform) | **Post** `/transforms` | Create transform [**delete-transform**](#delete-transform) | **Delete** `/transforms/{id}` | Delete a transform -[**get-transform**](#get-transform) | **Get** `/transforms/{id}` | Transform by ID +[**get-transform**](#get-transform) | **Get** `/transforms/{id}` | Transform by id [**list-transforms**](#list-transforms) | **Get** `/transforms` | List transforms [**update-transform**](#update-transform) | **Put** `/transforms/{id}` | Update a transform @@ -164,7 +164,7 @@ func main() { [[Back to top]](#) ## get-transform -Transform by ID +Transform by id This API returns the transform specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-transform) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/TriggersAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/TriggersAPI.md index d8a7f2ef6..d6222b594 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/TriggersAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/TriggersAPI.md @@ -56,16 +56,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**complete-trigger-invocation**](#complete-trigger-invocation) | **Post** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation -[**create-subscription**](#create-subscription) | **Post** `/trigger-subscriptions` | Create a Subscription -[**delete-subscription**](#delete-subscription) | **Delete** `/trigger-subscriptions/{id}` | Delete a Subscription -[**list-subscriptions**](#list-subscriptions) | **Get** `/trigger-subscriptions` | List Subscriptions -[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **Get** `/trigger-invocations/status` | List Latest Invocation Statuses -[**list-triggers**](#list-triggers) | **Get** `/triggers` | List Triggers -[**patch-subscription**](#patch-subscription) | **Patch** `/trigger-subscriptions/{id}` | Patch a Subscription -[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **Post** `/trigger-invocations/test` | Start a Test Invocation -[**test-subscription-filter**](#test-subscription-filter) | **Post** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter -[**update-subscription**](#update-subscription) | **Put** `/trigger-subscriptions/{id}` | Update a Subscription +[**complete-trigger-invocation**](#complete-trigger-invocation) | **Post** `/trigger-invocations/{id}/complete` | Complete trigger invocation +[**create-subscription**](#create-subscription) | **Post** `/trigger-subscriptions` | Create a subscription +[**delete-subscription**](#delete-subscription) | **Delete** `/trigger-subscriptions/{id}` | Delete a subscription +[**list-subscriptions**](#list-subscriptions) | **Get** `/trigger-subscriptions` | List subscriptions +[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **Get** `/trigger-invocations/status` | List latest invocation statuses +[**list-triggers**](#list-triggers) | **Get** `/triggers` | List triggers +[**patch-subscription**](#patch-subscription) | **Patch** `/trigger-subscriptions/{id}` | Patch a subscription +[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **Post** `/trigger-invocations/test` | Start a test invocation +[**test-subscription-filter**](#test-subscription-filter) | **Post** `/trigger-subscriptions/validate-filter` | Validate a subscription filter +[**update-subscription**](#update-subscription) | **Put** `/trigger-subscriptions/{id}` | Update a subscription ## complete-trigger-invocation @@ -80,7 +80,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Complete Trigger Invocation +Complete trigger invocation Completes an invocation to a REQUEST_RESPONSE type trigger. [API Spec](https://developer.sailpoint.com/docs/api/v2024/complete-trigger-invocation) @@ -171,7 +171,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create a Subscription +Create a subscription This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig @@ -277,7 +277,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete a Subscription +Delete a subscription Deletes an existing subscription to a trigger. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-subscription) @@ -355,7 +355,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Subscriptions +List subscriptions Gets a list of all trigger subscriptions. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-subscriptions) @@ -438,7 +438,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Latest Invocation Statuses +List latest invocation statuses Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. @@ -523,7 +523,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Triggers +List triggers Gets a list of triggers that are available in the tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-triggers) @@ -606,7 +606,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch a Subscription +Patch a subscription This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** @@ -694,7 +694,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Start a Test Invocation +Start a test invocation Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. [API Spec](https://developer.sailpoint.com/docs/api/v2024/start-test-trigger-invocation) @@ -783,7 +783,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Validate a Subscription Filter +Validate a subscription filter Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: @@ -869,7 +869,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update a Subscription +Update a subscription This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/UIMetadataAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/UIMetadataAPI.md index f384065b6..7df2c66b3 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/UIMetadataAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/UIMetadataAPI.md @@ -16,8 +16,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-tenant-ui-metadata**](#get-tenant-ui-metadata) | **Get** `/ui-metadata/tenant` | Get a tenant UI metadata -[**set-tenant-ui-metadata**](#set-tenant-ui-metadata) | **Put** `/ui-metadata/tenant` | Update tenant UI metadata +[**get-tenant-ui-metadata**](#get-tenant-ui-metadata) | **Get** `/ui-metadata/tenant` | Get a tenant ui metadata +[**set-tenant-ui-metadata**](#set-tenant-ui-metadata) | **Put** `/ui-metadata/tenant` | Update tenant ui metadata ## get-tenant-ui-metadata @@ -32,7 +32,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get a tenant UI metadata +Get a tenant ui metadata This API endpoint retrieves UI metadata configured for your tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant-ui-metadata) @@ -105,7 +105,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update tenant UI metadata +Update tenant ui metadata This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. [API Spec](https://developer.sailpoint.com/docs/api/v2024/set-tenant-ui-metadata) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/VendorConnectorMappingsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/VendorConnectorMappingsAPI.md index cd4fa5654..473a52d4c 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/VendorConnectorMappingsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/VendorConnectorMappingsAPI.md @@ -19,13 +19,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **Post** `/vendor-connector-mappings` | Create Vendor Connector Mapping -[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **Delete** `/vendor-connector-mappings` | Delete Vendor Connector Mapping -[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **Get** `/vendor-connector-mappings` | List Vendor Connector Mappings +[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **Post** `/vendor-connector-mappings` | Create vendor connector mapping +[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **Delete** `/vendor-connector-mappings` | Delete vendor connector mapping +[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **Get** `/vendor-connector-mappings` | List vendor connector mappings ## create-vendor-connector-mapping -Create Vendor Connector Mapping +Create vendor connector mapping Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. @@ -115,7 +115,7 @@ func main() { [[Back to top]](#) ## delete-vendor-connector-mapping -Delete Vendor Connector Mapping +Delete vendor connector mapping Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. @@ -205,7 +205,7 @@ func main() { [[Back to top]](#) ## get-vendor-connector-mappings -List Vendor Connector Mappings +List vendor connector mappings Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/WorkItemsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/WorkItemsAPI.md index 38e7c335f..ae52d578f 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/WorkItemsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/WorkItemsAPI.md @@ -29,23 +29,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-approval-item**](#approve-approval-item) | **Post** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item -[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **Post** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items -[**complete-work-item**](#complete-work-item) | **Post** `/work-items/{id}` | Complete a Work Item -[**forward-work-item**](#forward-work-item) | **Post** `/work-items/{id}/forward` | Forward a Work Item -[**get-completed-work-items**](#get-completed-work-items) | **Get** `/work-items/completed` | Completed Work Items -[**get-count-completed-work-items**](#get-count-completed-work-items) | **Get** `/work-items/completed/count` | Count Completed Work Items -[**get-count-work-items**](#get-count-work-items) | **Get** `/work-items/count` | Count Work Items -[**get-work-item**](#get-work-item) | **Get** `/work-items/{id}` | Get a Work Item -[**get-work-items-summary**](#get-work-items-summary) | **Get** `/work-items/summary` | Work Items Summary -[**list-work-items**](#list-work-items) | **Get** `/work-items` | List Work Items -[**reject-approval-item**](#reject-approval-item) | **Post** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item -[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **Post** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items -[**submit-account-selection**](#submit-account-selection) | **Post** `/work-items/{id}/submit-account-selection` | Submit Account Selections +[**approve-approval-item**](#approve-approval-item) | **Post** `/work-items/{id}/approve/{approvalItemId}` | Approve an approval item +[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **Post** `/work-items/bulk-approve/{id}` | Bulk approve approval items +[**complete-work-item**](#complete-work-item) | **Post** `/work-items/{id}` | Complete a work item +[**forward-work-item**](#forward-work-item) | **Post** `/work-items/{id}/forward` | Forward a work item +[**get-completed-work-items**](#get-completed-work-items) | **Get** `/work-items/completed` | Completed work items +[**get-count-completed-work-items**](#get-count-completed-work-items) | **Get** `/work-items/completed/count` | Count completed work items +[**get-count-work-items**](#get-count-work-items) | **Get** `/work-items/count` | Count work items +[**get-work-item**](#get-work-item) | **Get** `/work-items/{id}` | Get a work item +[**get-work-items-summary**](#get-work-items-summary) | **Get** `/work-items/summary` | Work items summary +[**list-work-items**](#list-work-items) | **Get** `/work-items` | List work items +[**reject-approval-item**](#reject-approval-item) | **Post** `/work-items/{id}/reject/{approvalItemId}` | Reject an approval item +[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **Post** `/work-items/bulk-reject/{id}` | Bulk reject approval items +[**submit-account-selection**](#submit-account-selection) | **Post** `/work-items/{id}/submit-account-selection` | Submit account selections ## approve-approval-item -Approve an Approval Item +Approve an approval item This API approves an Approval Item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-approval-item) @@ -114,7 +114,7 @@ func main() { [[Back to top]](#) ## approve-approval-items-in-bulk -Bulk approve Approval Items +Bulk approve approval items This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-approval-items-in-bulk) @@ -180,7 +180,7 @@ func main() { [[Back to top]](#) ## complete-work-item -Complete a Work Item +Complete a work item This API completes a work item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2024/complete-work-item) @@ -259,7 +259,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Forward a Work Item +Forward a work item This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2024/forward-work-item) @@ -337,7 +337,7 @@ func main() { [[Back to top]](#) ## get-completed-work-items -Completed Work Items +Completed work items This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-completed-work-items) @@ -416,7 +416,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Count Completed Work Items +Count completed work items This gets a count of completed work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-count-completed-work-items) @@ -480,7 +480,7 @@ func main() { [[Back to top]](#) ## get-count-work-items -Count Work Items +Count work items This gets a count of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-count-work-items) @@ -542,7 +542,7 @@ func main() { [[Back to top]](#) ## get-work-item -Get a Work Item +Get a work item This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-work-item) @@ -608,7 +608,7 @@ func main() { [[Back to top]](#) ## get-work-items-summary -Work Items Summary +Work items summary This gets a summary of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-work-items-summary) @@ -670,7 +670,7 @@ func main() { [[Back to top]](#) ## list-work-items -List Work Items +List work items This gets a collection of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-work-items) @@ -738,7 +738,7 @@ func main() { [[Back to top]](#) ## reject-approval-item -Reject an Approval Item +Reject an approval item This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-approval-item) @@ -807,7 +807,7 @@ func main() { [[Back to top]](#) ## reject-approval-items-in-bulk -Bulk reject Approval Items +Bulk reject approval items This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-approval-items-in-bulk) @@ -873,7 +873,7 @@ func main() { [[Back to top]](#) ## submit-account-selection -Submit Account Selections +Submit account selections This API submits account selections. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-account-selection) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/WorkReassignmentAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/WorkReassignmentAPI.md index 7684ac1bc..8afb733ce 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/WorkReassignmentAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/WorkReassignmentAPI.md @@ -25,15 +25,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-reassignment-configuration**](#create-reassignment-configuration) | **Post** `/reassignment-configurations` | Create a Reassignment Configuration -[**delete-reassignment-configuration**](#delete-reassignment-configuration) | **Delete** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration -[**get-evaluate-reassignment-configuration**](#get-evaluate-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration -[**get-reassignment-config-types**](#get-reassignment-config-types) | **Get** `/reassignment-configurations/types` | List Reassignment Config Types -[**get-reassignment-configuration**](#get-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration -[**get-tenant-config-configuration**](#get-tenant-config-configuration) | **Get** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings -[**list-reassignment-configurations**](#list-reassignment-configurations) | **Get** `/reassignment-configurations` | List Reassignment Configurations -[**put-reassignment-config**](#put-reassignment-config) | **Put** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration -[**put-tenant-configuration**](#put-tenant-configuration) | **Put** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings +[**create-reassignment-configuration**](#create-reassignment-configuration) | **Post** `/reassignment-configurations` | Create a reassignment configuration +[**delete-reassignment-configuration**](#delete-reassignment-configuration) | **Delete** `/reassignment-configurations/{identityId}/{configType}` | Delete reassignment configuration +[**get-evaluate-reassignment-configuration**](#get-evaluate-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate reassignment configuration +[**get-reassignment-config-types**](#get-reassignment-config-types) | **Get** `/reassignment-configurations/types` | List reassignment config types +[**get-reassignment-configuration**](#get-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}` | Get reassignment configuration +[**get-tenant-config-configuration**](#get-tenant-config-configuration) | **Get** `/reassignment-configurations/tenant-config` | Get tenant-wide reassignment configuration settings +[**list-reassignment-configurations**](#list-reassignment-configurations) | **Get** `/reassignment-configurations` | List reassignment configurations +[**put-reassignment-config**](#put-reassignment-config) | **Put** `/reassignment-configurations/{identityId}` | Update reassignment configuration +[**put-tenant-configuration**](#put-tenant-configuration) | **Put** `/reassignment-configurations/tenant-config` | Update tenant-wide reassignment configuration settings ## create-reassignment-configuration @@ -48,7 +48,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create a Reassignment Configuration +Create a reassignment configuration Creates a new Reassignment Configuration for the specified identity. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-reassignment-configuration) @@ -134,7 +134,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Reassignment Configuration +Delete reassignment configuration Deletes a single reassignment configuration for the specified identity [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-reassignment-configuration) @@ -215,7 +215,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Evaluate Reassignment Configuration +Evaluate reassignment configuration Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-evaluate-reassignment-configuration) @@ -299,7 +299,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Reassignment Config Types +List reassignment config types Gets a collection of types which are available in the Reassignment Configuration UI. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-reassignment-config-types) @@ -372,7 +372,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Reassignment Configuration +Get reassignment configuration Gets the Reassignment Configuration for an identity. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-reassignment-configuration) @@ -451,7 +451,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Tenant-wide Reassignment Configuration settings +Get tenant-wide reassignment configuration settings Gets the global Reassignment Configuration settings for the requestor's tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant-config-configuration) @@ -524,7 +524,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Reassignment Configurations +List reassignment configurations Gets all Reassignment configuration for the current org. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-reassignment-configurations) @@ -597,7 +597,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Reassignment Configuration +Update reassignment configuration Replaces existing Reassignment configuration for an identity with the newly provided configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-reassignment-config) @@ -689,7 +689,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Tenant-wide Reassignment Configuration settings +Update tenant-wide reassignment configuration settings Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-tenant-configuration) diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/WorkflowsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/WorkflowsAPI.md index fbd381792..b8aa5aff5 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/WorkflowsAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/WorkflowsAPI.md @@ -16,28 +16,28 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**cancel-workflow-execution**](#cancel-workflow-execution) | **Post** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID -[**create-external-execute-workflow**](#create-external-execute-workflow) | **Post** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger -[**create-workflow**](#create-workflow) | **Post** `/workflows` | Create Workflow -[**create-workflow-external-trigger**](#create-workflow-external-trigger) | **Post** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client -[**delete-workflow**](#delete-workflow) | **Delete** `/workflows/{id}` | Delete Workflow By Id -[**get-workflow**](#get-workflow) | **Get** `/workflows/{id}` | Get Workflow By Id -[**get-workflow-execution**](#get-workflow-execution) | **Get** `/workflow-executions/{id}` | Get Workflow Execution -[**get-workflow-execution-history**](#get-workflow-execution-history) | **Get** `/workflow-executions/{id}/history` | Get Workflow Execution History -[**get-workflow-executions**](#get-workflow-executions) | **Get** `/workflows/{id}/executions` | List Workflow Executions -[**list-complete-workflow-library**](#list-complete-workflow-library) | **Get** `/workflow-library` | List Complete Workflow Library -[**list-workflow-library-actions**](#list-workflow-library-actions) | **Get** `/workflow-library/actions` | List Workflow Library Actions -[**list-workflow-library-operators**](#list-workflow-library-operators) | **Get** `/workflow-library/operators` | List Workflow Library Operators -[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **Get** `/workflow-library/triggers` | List Workflow Library Triggers -[**list-workflows**](#list-workflows) | **Get** `/workflows` | List Workflows -[**patch-workflow**](#patch-workflow) | **Patch** `/workflows/{id}` | Patch Workflow -[**put-workflow**](#put-workflow) | **Put** `/workflows/{id}` | Update Workflow -[**test-external-execute-workflow**](#test-external-execute-workflow) | **Post** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger -[**test-workflow**](#test-workflow) | **Post** `/workflows/{id}/test` | Test Workflow By Id +[**cancel-workflow-execution**](#cancel-workflow-execution) | **Post** `/workflow-executions/{id}/cancel` | Cancel workflow execution by id +[**create-external-execute-workflow**](#create-external-execute-workflow) | **Post** `/workflows/execute/external/{id}` | Execute workflow via external trigger +[**create-workflow**](#create-workflow) | **Post** `/workflows` | Create workflow +[**create-workflow-external-trigger**](#create-workflow-external-trigger) | **Post** `/workflows/{id}/external/oauth-clients` | Generate external trigger oauth client +[**delete-workflow**](#delete-workflow) | **Delete** `/workflows/{id}` | Delete workflow by id +[**get-workflow**](#get-workflow) | **Get** `/workflows/{id}` | Get workflow by id +[**get-workflow-execution**](#get-workflow-execution) | **Get** `/workflow-executions/{id}` | Get workflow execution +[**get-workflow-execution-history**](#get-workflow-execution-history) | **Get** `/workflow-executions/{id}/history` | Get workflow execution history +[**get-workflow-executions**](#get-workflow-executions) | **Get** `/workflows/{id}/executions` | List workflow executions +[**list-complete-workflow-library**](#list-complete-workflow-library) | **Get** `/workflow-library` | List complete workflow library +[**list-workflow-library-actions**](#list-workflow-library-actions) | **Get** `/workflow-library/actions` | List workflow library actions +[**list-workflow-library-operators**](#list-workflow-library-operators) | **Get** `/workflow-library/operators` | List workflow library operators +[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **Get** `/workflow-library/triggers` | List workflow library triggers +[**list-workflows**](#list-workflows) | **Get** `/workflows` | List workflows +[**patch-workflow**](#patch-workflow) | **Patch** `/workflows/{id}` | Patch workflow +[**put-workflow**](#put-workflow) | **Put** `/workflows/{id}` | Update workflow +[**test-external-execute-workflow**](#test-external-execute-workflow) | **Post** `/workflows/execute/external/{id}/test` | Test workflow via external trigger +[**test-workflow**](#test-workflow) | **Post** `/workflows/{id}/test` | Test workflow by id ## cancel-workflow-execution -Cancel Workflow Execution by ID +Cancel workflow execution by id Use this API to cancel a running workflow execution. [API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-workflow-execution) @@ -102,7 +102,7 @@ func main() { [[Back to top]](#) ## create-external-execute-workflow -Execute Workflow via External Trigger +Execute workflow via external trigger This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-external-execute-workflow) @@ -170,7 +170,7 @@ func main() { [[Back to top]](#) ## create-workflow -Create Workflow +Create workflow Create a new workflow with the desired trigger and steps specified in the request body. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workflow) @@ -237,7 +237,7 @@ func main() { [[Back to top]](#) ## create-workflow-external-trigger -Generate External Trigger OAuth Client +Generate external trigger oauth client Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workflow-external-trigger) @@ -303,7 +303,7 @@ func main() { [[Back to top]](#) ## delete-workflow -Delete Workflow By Id +Delete workflow by id Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workflow) @@ -368,7 +368,7 @@ func main() { [[Back to top]](#) ## get-workflow -Get Workflow By Id +Get workflow by id Get a single workflow by id. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow) @@ -434,7 +434,7 @@ func main() { [[Back to top]](#) ## get-workflow-execution -Get Workflow Execution +Get workflow execution Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow-execution) @@ -500,7 +500,7 @@ func main() { [[Back to top]](#) ## get-workflow-execution-history -Get Workflow Execution History +Get workflow execution history Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow-execution-history) @@ -566,7 +566,7 @@ func main() { [[Back to top]](#) ## get-workflow-executions -List Workflow Executions +List workflow executions Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. @@ -650,7 +650,7 @@ func main() { [[Back to top]](#) ## list-complete-workflow-library -List Complete Workflow Library +List complete workflow library This lists all triggers, actions, and operators in the library [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-complete-workflow-library) @@ -714,7 +714,7 @@ func main() { [[Back to top]](#) ## list-workflow-library-actions -List Workflow Library Actions +List workflow library actions This lists the workflow actions available to you. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflow-library-actions) @@ -780,7 +780,7 @@ func main() { [[Back to top]](#) ## list-workflow-library-operators -List Workflow Library Operators +List workflow library operators This lists the workflow operators available to you [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflow-library-operators) @@ -837,7 +837,7 @@ func main() { [[Back to top]](#) ## list-workflow-library-triggers -List Workflow Library Triggers +List workflow library triggers This lists the workflow triggers available to you [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflow-library-triggers) @@ -903,7 +903,7 @@ func main() { [[Back to top]](#) ## list-workflows -List Workflows +List workflows List all workflows in the tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflows) @@ -960,7 +960,7 @@ func main() { [[Back to top]](#) ## patch-workflow -Patch Workflow +Patch workflow Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-workflow) @@ -1033,7 +1033,7 @@ func main() { [[Back to top]](#) ## put-workflow -Update Workflow +Update workflow Perform a full update of a workflow. The updated workflow object is returned in the response. [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-workflow) @@ -1139,7 +1139,7 @@ func main() { [[Back to top]](#) ## test-external-execute-workflow -Test Workflow via External Trigger +Test workflow via external trigger Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. [API Spec](https://developer.sailpoint.com/docs/api/v2024/test-external-execute-workflow) @@ -1207,7 +1207,7 @@ func main() { [[Back to top]](#) ## test-workflow -Test Workflow By Id +Test workflow by id :::info Workflow must be disabled in order to use this endpoint. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccessModelMetadataAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccessModelMetadataAPI.md index 188309cda..533ba74b4 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/AccessModelMetadataAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccessModelMetadataAPI.md @@ -25,10 +25,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-access-model-metadata-attribute**](#get-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute -[**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value -[**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes` | List Access Model Metadata Attributes -[**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values +[**get-access-model-metadata-attribute**](#get-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes/{key}` | Get access model metadata attribute +[**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values/{value}` | Get access model metadata value +[**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes` | List access model metadata attributes +[**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values` | List access model metadata values ## get-access-model-metadata-attribute @@ -43,7 +43,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Access Model Metadata Attribute +Get access model metadata attribute Get single Access Model Metadata Attribute [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-model-metadata-attribute) @@ -122,7 +122,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Access Model Metadata Value +Get access model metadata value Get single Access Model Metadata Attribute Value [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-model-metadata-attribute-value) @@ -204,7 +204,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Access Model Metadata Attributes +List access model metadata attributes Get a list of Access Model Metadata Attributes [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-access-model-metadata-attribute) @@ -279,7 +279,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Access Model Metadata Values +List access model metadata values Get a list of Access Model Metadata Attribute Values [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-access-model-metadata-attribute-value) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccessProfilesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccessProfilesAPI.md index 19b967f67..d3c4da037 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/AccessProfilesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccessProfilesAPI.md @@ -49,18 +49,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-access-profile**](#create-access-profile) | **Post** `/access-profiles` | Create Access Profile -[**delete-access-profile**](#delete-access-profile) | **Delete** `/access-profiles/{id}` | Delete the specified Access Profile -[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-delete` | Delete Access Profile(s) -[**get-access-profile**](#get-access-profile) | **Get** `/access-profiles/{id}` | Get an Access Profile -[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **Get** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements -[**list-access-profiles**](#list-access-profiles) | **Get** `/access-profiles` | List Access Profiles -[**patch-access-profile**](#patch-access-profile) | **Patch** `/access-profiles/{id}` | Patch a specified Access Profile -[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. +[**create-access-profile**](#create-access-profile) | **Post** `/access-profiles` | Create access profile +[**delete-access-profile**](#delete-access-profile) | **Delete** `/access-profiles/{id}` | Delete the specified access profile +[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-delete` | Delete access profile(s) +[**get-access-profile**](#get-access-profile) | **Get** `/access-profiles/{id}` | Get an access profile +[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **Get** `/access-profiles/{id}/entitlements` | List access profile's entitlements +[**list-access-profiles**](#list-access-profiles) | **Get** `/access-profiles` | List access profiles +[**patch-access-profile**](#patch-access-profile) | **Patch** `/access-profiles/{id}` | Patch a specified access profile +[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-update-requestable` | Update access profile(s) requestable field. ## create-access-profile -Create Access Profile +Create access profile Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. @@ -215,7 +215,7 @@ func main() { [[Back to top]](#) ## delete-access-profile -Delete the specified Access Profile +Delete the specified access profile This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. @@ -284,7 +284,7 @@ func main() { [[Back to top]](#) ## delete-access-profiles-in-bulk -Delete Access Profile(s) +Delete access profile(s) This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. @@ -358,7 +358,7 @@ func main() { [[Back to top]](#) ## get-access-profile -Get an Access Profile +Get an access profile This API returns an Access Profile by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-profile) @@ -424,7 +424,7 @@ func main() { [[Back to top]](#) ## get-access-profile-entitlements -List Access Profile's Entitlements +List access profile's entitlements Use this API to get a list of an access profile's entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. @@ -502,7 +502,7 @@ func main() { [[Back to top]](#) ## list-access-profiles -List Access Profiles +List access profiles Get a list of access profiles. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. @@ -579,7 +579,7 @@ func main() { [[Back to top]](#) ## patch-access-profile -Patch a specified Access Profile +Patch a specified access profile This API updates an existing Access Profile. The following fields are patchable: **name** @@ -692,7 +692,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Access Profile(s) requestable field. +Update access profile(s) requestable field. This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestApprovalsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestApprovalsAPI.md index d211da35e..4ddaa22b7 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestApprovalsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestApprovalsAPI.md @@ -32,17 +32,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-access-request**](#approve-access-request) | **Post** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval -[**forward-access-request**](#forward-access-request) | **Post** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval -[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **Get** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number -[**list-access-request-approvers**](#list-access-request-approvers) | **Get** `/access-request-approvals/{accessRequestId}/approvers` | Access Request Approvers -[**list-completed-approvals**](#list-completed-approvals) | **Get** `/access-request-approvals/completed` | Completed Access Request Approvals List -[**list-pending-approvals**](#list-pending-approvals) | **Get** `/access-request-approvals/pending` | Pending Access Request Approvals List -[**reject-access-request**](#reject-access-request) | **Post** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval +[**approve-access-request**](#approve-access-request) | **Post** `/access-request-approvals/{approvalId}/approve` | Approve access request approval +[**forward-access-request**](#forward-access-request) | **Post** `/access-request-approvals/{approvalId}/forward` | Forward access request approval +[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **Get** `/access-request-approvals/approval-summary` | Get access requests approvals number +[**list-access-request-approvers**](#list-access-request-approvers) | **Get** `/access-request-approvals/{accessRequestId}/approvers` | Access request approvers +[**list-completed-approvals**](#list-completed-approvals) | **Get** `/access-request-approvals/completed` | Completed access request approvals list +[**list-pending-approvals**](#list-pending-approvals) | **Get** `/access-request-approvals/pending` | Pending access request approvals list +[**reject-access-request**](#reject-access-request) | **Post** `/access-request-approvals/{approvalId}/reject` | Reject access request approval ## approve-access-request -Approve Access Request Approval +Approve access request approval Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. [API Spec](https://developer.sailpoint.com/docs/api/v2025/approve-access-request) @@ -118,7 +118,7 @@ func main() { [[Back to top]](#) ## forward-access-request -Forward Access Request Approval +Forward access request approval Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. [API Spec](https://developer.sailpoint.com/docs/api/v2025/forward-access-request) @@ -194,7 +194,7 @@ func main() { [[Back to top]](#) ## get-access-request-approval-summary -Get Access Requests Approvals Number +Get access requests approvals number Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-approval-summary) @@ -258,7 +258,7 @@ func main() { [[Back to top]](#) ## list-access-request-approvers -Access Request Approvers +Access request approvers This API endpoint returns the list of approvers for the given access request id. @@ -331,7 +331,7 @@ func main() { [[Back to top]](#) ## list-completed-approvals -Completed Access Request Approvals List +Completed access request approvals list This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-completed-approvals) @@ -403,7 +403,7 @@ func main() { [[Back to top]](#) ## list-pending-approvals -Pending Access Request Approvals List +Pending access request approvals list This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-pending-approvals) @@ -475,7 +475,7 @@ func main() { [[Back to top]](#) ## reject-access-request -Reject Access Request Approval +Reject access request approval Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. [API Spec](https://developer.sailpoint.com/docs/api/v2025/reject-access-request) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestsAPI.md index c77d35bd1..e452fd9a3 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestsAPI.md @@ -30,21 +30,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-bulk-access-request**](#approve-bulk-access-request) | **Post** `/access-request-approvals/bulk-approve` | Bulk Approve Access Request -[**cancel-access-request**](#cancel-access-request) | **Post** `/access-requests/cancel` | Cancel Access Request -[**cancel-access-request-in-bulk**](#cancel-access-request-in-bulk) | **Post** `/access-requests/bulk-cancel` | Bulk Cancel Access Request -[**close-access-request**](#close-access-request) | **Post** `/access-requests/close` | Close Access Request -[**create-access-request**](#create-access-request) | **Post** `/access-requests` | Submit Access Request -[**get-access-request-config**](#get-access-request-config) | **Get** `/access-request-config` | Get Access Request Configuration -[**get-entitlement-details-for-identity**](#get-entitlement-details-for-identity) | **Get** `/access-requests/revocable-objects` | Identity Entitlement Details -[**list-access-request-status**](#list-access-request-status) | **Get** `/access-request-status` | Access Request Status -[**list-administrators-access-request-status**](#list-administrators-access-request-status) | **Get** `/access-request-administration` | Access Request Status for Administrators +[**approve-bulk-access-request**](#approve-bulk-access-request) | **Post** `/access-request-approvals/bulk-approve` | Bulk approve access request +[**cancel-access-request**](#cancel-access-request) | **Post** `/access-requests/cancel` | Cancel access request +[**cancel-access-request-in-bulk**](#cancel-access-request-in-bulk) | **Post** `/access-requests/bulk-cancel` | Bulk cancel access request +[**close-access-request**](#close-access-request) | **Post** `/access-requests/close` | Close access request +[**create-access-request**](#create-access-request) | **Post** `/access-requests` | Submit access request +[**get-access-request-config**](#get-access-request-config) | **Get** `/access-request-config` | Get access request configuration +[**get-entitlement-details-for-identity**](#get-entitlement-details-for-identity) | **Get** `/access-requests/revocable-objects` | Identity entitlement details +[**list-access-request-status**](#list-access-request-status) | **Get** `/access-request-status` | Access request status +[**list-administrators-access-request-status**](#list-administrators-access-request-status) | **Get** `/access-request-administration` | Access request status for administrators [**load-account-selections**](#load-account-selections) | **Post** `/access-requests/accounts-selection` | Get accounts selections for identity -[**set-access-request-config**](#set-access-request-config) | **Put** `/access-request-config` | Update Access Request Configuration +[**set-access-request-config**](#set-access-request-config) | **Put** `/access-request-config` | Update access request configuration ## approve-bulk-access-request -Bulk Approve Access Request +Bulk approve access request This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights "idn:access-request-administration:write" can approve the access requests in bulk. [API Spec](https://developer.sailpoint.com/docs/api/v2025/approve-bulk-access-request) @@ -114,7 +114,7 @@ func main() { [[Back to top]](#) ## cancel-access-request -Cancel Access Request +Cancel access request This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. @@ -185,7 +185,7 @@ func main() { [[Back to top]](#) ## cancel-access-request-in-bulk -Bulk Cancel Access Request +Bulk cancel access request This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights "idn:access-request-administration:write" can cancel the access requests in bulk. @@ -267,7 +267,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Close Access Request +Close access request This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. @@ -352,7 +352,7 @@ func main() { [[Back to top]](#) ## create-access-request -Submit Access Request +Submit access request Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request @@ -634,7 +634,7 @@ func main() { [[Back to top]](#) ## get-access-request-config -Get Access Request Configuration +Get access request configuration This endpoint returns the current access-request configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-config) @@ -702,7 +702,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Identity Entitlement Details +Identity entitlement details Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement-details-for-identity) @@ -773,7 +773,7 @@ func main() { [[Back to top]](#) ## list-access-request-status -Access Request Status +Access request status Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. @@ -855,7 +855,7 @@ func main() { [[Back to top]](#) ## list-administrators-access-request-status -Access Request Status for Administrators +Access request status for administrators Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses @@ -1069,7 +1069,7 @@ func main() { [[Back to top]](#) ## set-access-request-config -Update Access Request Configuration +Update access request configuration This endpoint replaces the current access-request configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2025/set-access-request-config) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccountActivitiesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccountActivitiesAPI.md index aacffa3d7..e09c77000 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/AccountActivitiesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccountActivitiesAPI.md @@ -48,12 +48,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-account-activity**](#get-account-activity) | **Get** `/account-activities/{id}` | Get an Account Activity -[**list-account-activities**](#list-account-activities) | **Get** `/account-activities` | List Account Activities +[**get-account-activity**](#get-account-activity) | **Get** `/account-activities/{id}` | Get an account activity +[**list-account-activities**](#list-account-activities) | **Get** `/account-activities` | List account activities ## get-account-activity -Get an Account Activity +Get an account activity This gets a single account activity by its id. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-account-activity) @@ -119,7 +119,7 @@ func main() { [[Back to top]](#) ## list-account-activities -List Account Activities +List account activities This gets a collection of account activities that satisfy the given query parameters. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-account-activities) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccountAggregationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccountAggregationsAPI.md index f50dc48cc..ccae4fcd8 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/AccountAggregationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccountAggregationsAPI.md @@ -25,7 +25,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-account-aggregation-status**](#get-account-aggregation-status) | **Get** `/account-aggregations/{id}/status` | In-progress Account Aggregation status +[**get-account-aggregation-status**](#get-account-aggregation-status) | **Get** `/account-aggregations/{id}/status` | In-progress account aggregation status ## get-account-aggregation-status @@ -40,7 +40,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -In-progress Account Aggregation status +In-progress account aggregation status This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccountsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccountsAPI.md index fed97e14f..2549e7969 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/AccountsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccountsAPI.md @@ -42,26 +42,26 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-account**](#create-account) | **Post** `/accounts` | Create Account -[**delete-account**](#delete-account) | **Delete** `/accounts/{id}` | Delete Account -[**delete-account-async**](#delete-account-async) | **Post** `/accounts/{id}/remove` | Remove Account -[**disable-account**](#disable-account) | **Post** `/accounts/{id}/disable` | Disable Account -[**disable-account-for-identity**](#disable-account-for-identity) | **Post** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity -[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **Post** `/identities-accounts/disable` | Disable IDN Accounts for Identities -[**enable-account**](#enable-account) | **Post** `/accounts/{id}/enable` | Enable Account -[**enable-account-for-identity**](#enable-account-for-identity) | **Post** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity -[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **Post** `/identities-accounts/enable` | Enable IDN Accounts for Identities -[**get-account**](#get-account) | **Get** `/accounts/{id}` | Account Details -[**get-account-entitlements**](#get-account-entitlements) | **Get** `/accounts/{id}/entitlements` | Account Entitlements -[**list-accounts**](#list-accounts) | **Get** `/accounts` | Accounts List -[**put-account**](#put-account) | **Put** `/accounts/{id}` | Update Account -[**submit-reload-account**](#submit-reload-account) | **Post** `/accounts/{id}/reload` | Reload Account -[**unlock-account**](#unlock-account) | **Post** `/accounts/{id}/unlock` | Unlock Account -[**update-account**](#update-account) | **Patch** `/accounts/{id}` | Update Account +[**create-account**](#create-account) | **Post** `/accounts` | Create account +[**delete-account**](#delete-account) | **Delete** `/accounts/{id}` | Delete account +[**delete-account-async**](#delete-account-async) | **Post** `/accounts/{id}/remove` | Remove account +[**disable-account**](#disable-account) | **Post** `/accounts/{id}/disable` | Disable account +[**disable-account-for-identity**](#disable-account-for-identity) | **Post** `/identities-accounts/{id}/disable` | Disable idn account for identity +[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **Post** `/identities-accounts/disable` | Disable idn accounts for identities +[**enable-account**](#enable-account) | **Post** `/accounts/{id}/enable` | Enable account +[**enable-account-for-identity**](#enable-account-for-identity) | **Post** `/identities-accounts/{id}/enable` | Enable idn account for identity +[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **Post** `/identities-accounts/enable` | Enable idn accounts for identities +[**get-account**](#get-account) | **Get** `/accounts/{id}` | Account details +[**get-account-entitlements**](#get-account-entitlements) | **Get** `/accounts/{id}/entitlements` | Account entitlements +[**list-accounts**](#list-accounts) | **Get** `/accounts` | Accounts list +[**put-account**](#put-account) | **Put** `/accounts/{id}` | Update account +[**submit-reload-account**](#submit-reload-account) | **Post** `/accounts/{id}/reload` | Reload account +[**unlock-account**](#unlock-account) | **Post** `/accounts/{id}/unlock` | Unlock account +[**update-account**](#update-account) | **Patch** `/accounts/{id}` | Update account ## create-account -Create Account +Create account Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. @@ -148,7 +148,7 @@ func main() { [[Back to top]](#) ## delete-account -Delete Account +Delete account Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. @@ -228,7 +228,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Remove Account +Remove account Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: @@ -302,7 +302,7 @@ func main() { [[Back to top]](#) ## disable-account -Disable Account +Disable account This API submits a task to disable the account and returns the task ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/disable-account) @@ -389,7 +389,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Disable IDN Account for Identity +Disable idn account for identity This API submits a task to disable IDN account for a single identity. [API Spec](https://developer.sailpoint.com/docs/api/v2025/disable-account-for-identity) @@ -468,7 +468,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Disable IDN Accounts for Identities +Disable idn accounts for identities This API submits tasks to disable IDN account for each identity provided in the request body. [API Spec](https://developer.sailpoint.com/docs/api/v2025/disable-accounts-for-identities) @@ -539,7 +539,7 @@ func main() { [[Back to top]](#) ## enable-account -Enable Account +Enable account This API submits a task to enable account and returns the task ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/enable-account) @@ -626,7 +626,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Enable IDN Account for Identity +Enable idn account for identity This API submits a task to enable IDN account for a single identity. [API Spec](https://developer.sailpoint.com/docs/api/v2025/enable-account-for-identity) @@ -705,7 +705,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Enable IDN Accounts for Identities +Enable idn accounts for identities This API submits tasks to enable IDN account for each identity provided in the request body. [API Spec](https://developer.sailpoint.com/docs/api/v2025/enable-accounts-for-identities) @@ -776,7 +776,7 @@ func main() { [[Back to top]](#) ## get-account -Account Details +Account details Use this API to return the details for a single account by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-account) @@ -842,7 +842,7 @@ func main() { [[Back to top]](#) ## get-account-entitlements -Account Entitlements +Account entitlements This API returns entitlements of the account. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-account-entitlements) @@ -914,7 +914,7 @@ func main() { [[Back to top]](#) ## list-accounts -Accounts List +Accounts list List accounts. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-accounts) @@ -986,7 +986,7 @@ func main() { [[Back to top]](#) ## put-account -Update Account +Update account Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. @@ -1072,7 +1072,7 @@ func main() { [[Back to top]](#) ## submit-reload-account -Reload Account +Reload account This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. [API Spec](https://developer.sailpoint.com/docs/api/v2025/submit-reload-account) @@ -1138,7 +1138,7 @@ func main() { [[Back to top]](#) ## unlock-account -Unlock Account +Unlock account This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. @@ -1216,7 +1216,7 @@ func main() { [[Back to top]](#) ## update-account -Update Account +Update account Use this API to update account details. This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ApplicationDiscoveryAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ApplicationDiscoveryAPI.md index 945c5e062..ec14ae8d2 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/ApplicationDiscoveryAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ApplicationDiscoveryAPI.md @@ -17,13 +17,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-discovered-applications**](#get-discovered-applications) | **Get** `/discovered-applications` | Get Discovered Applications for Tenant -[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **Get** `/manual-discover-applications-template` | Download CSV Template for Discovery -[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **Post** `/manual-discover-applications` | Upload CSV to Discover Applications +[**get-discovered-applications**](#get-discovered-applications) | **Get** `/discovered-applications` | Get discovered applications for tenant +[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **Get** `/manual-discover-applications-template` | Download csv template for discovery +[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **Post** `/manual-discover-applications` | Upload csv to discover applications ## get-discovered-applications -Get Discovered Applications for Tenant +Get discovered applications for tenant Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. @@ -94,7 +94,7 @@ func main() { [[Back to top]](#) ## get-manual-discover-applications-csv-template -Download CSV Template for Discovery +Download csv template for discovery Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. @@ -154,7 +154,7 @@ func main() { [[Back to top]](#) ## send-manual-discover-applications-csv-template -Upload CSV to Discover Applications +Upload csv to discover applications Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ApprovalsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ApprovalsAPI.md index b415e722a..725631f24 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/ApprovalsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ApprovalsAPI.md @@ -19,7 +19,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**get-approval**](#get-approval) | **Get** `/generic-approvals/{id}` | Get an approval -[**get-approvals**](#get-approvals) | **Get** `/generic-approvals` | Get Approvals +[**get-approvals**](#get-approvals) | **Get** `/generic-approvals` | Get approvals ## get-approval @@ -113,7 +113,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Approvals +Get approvals Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. "Mine" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. Absence of all query parameters will will default to mine=true. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AppsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AppsAPI.md index 55fa1051f..639cce983 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/AppsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AppsAPI.md @@ -19,8 +19,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create-source-app**](#create-source-app) | **Post** `/source-apps` | Create source app [**delete-access-profiles-from-source-app-by-bulk**](#delete-access-profiles-from-source-app-by-bulk) | **Post** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app -[**delete-source-app**](#delete-source-app) | **Delete** `/source-apps/{id}` | Delete source app by ID -[**get-source-app**](#get-source-app) | **Get** `/source-apps/{id}` | Get source app by ID +[**delete-source-app**](#delete-source-app) | **Delete** `/source-apps/{id}` | Delete source app by id +[**get-source-app**](#get-source-app) | **Get** `/source-apps/{id}` | Get source app by id [**list-access-profiles-for-source-app**](#list-access-profiles-for-source-app) | **Get** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app [**list-all-source-app**](#list-all-source-app) | **Get** `/source-apps/all` | List all source apps [**list-all-user-apps**](#list-all-user-apps) | **Get** `/user-apps/all` | List all user apps @@ -28,8 +28,8 @@ Method | HTTP request | Description [**list-available-accounts-for-user-app**](#list-available-accounts-for-user-app) | **Get** `/user-apps/{id}/available-accounts` | List available accounts for user app [**list-available-source-apps**](#list-available-source-apps) | **Get** `/source-apps` | List available source apps [**list-owned-user-apps**](#list-owned-user-apps) | **Get** `/user-apps` | List owned user apps -[**patch-source-app**](#patch-source-app) | **Patch** `/source-apps/{id}` | Patch source app by ID -[**patch-user-app**](#patch-user-app) | **Patch** `/user-apps/{id}` | Patch user app by ID +[**patch-source-app**](#patch-source-app) | **Patch** `/source-apps/{id}` | Patch source app by id +[**patch-user-app**](#patch-user-app) | **Patch** `/user-apps/{id}` | Patch user app by id [**update-source-apps-in-bulk**](#update-source-apps-in-bulk) | **Post** `/source-apps/bulk-update` | Bulk update source apps @@ -222,7 +222,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete source app by ID +Delete source app by id Use this API to delete a specific source app [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-source-app) @@ -301,7 +301,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get source app by ID +Get source app by id This API returns a source app by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-app) @@ -960,7 +960,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch source app by ID +Patch source app by id This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can't be empty or null. @@ -1043,7 +1043,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch user app by ID +Patch user app by id This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AuthProfileAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AuthProfileAPI.md index 2b102ccff..68450679a 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/AuthProfileAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AuthProfileAPI.md @@ -21,9 +21,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-profile-config**](#get-profile-config) | **Get** `/auth-profiles/{id}` | Get Auth Profile -[**get-profile-config-list**](#get-profile-config-list) | **Get** `/auth-profiles` | Get list of Auth Profiles -[**patch-profile-config**](#patch-profile-config) | **Patch** `/auth-profiles/{id}` | Patch a specified Auth Profile +[**get-profile-config**](#get-profile-config) | **Get** `/auth-profiles/{id}` | Get auth profile +[**get-profile-config-list**](#get-profile-config-list) | **Get** `/auth-profiles` | Get list of auth profiles +[**patch-profile-config**](#patch-profile-config) | **Patch** `/auth-profiles/{id}` | Patch a specified auth profile ## get-profile-config @@ -38,7 +38,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Auth Profile +Get auth profile This API returns auth profile information. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-profile-config) @@ -117,7 +117,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get list of Auth Profiles +Get list of auth profiles This API returns a list of auth profiles. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-profile-config-list) @@ -190,7 +190,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch a specified Auth Profile +Patch a specified auth profile This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AuthUsersAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AuthUsersAPI.md index c7c664a91..bec2bf61a 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/AuthUsersAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AuthUsersAPI.md @@ -20,12 +20,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-auth-user**](#get-auth-user) | **Get** `/auth-users/{id}` | Auth User Details -[**patch-auth-user**](#patch-auth-user) | **Patch** `/auth-users/{id}` | Auth User Update +[**get-auth-user**](#get-auth-user) | **Get** `/auth-users/{id}` | Auth user details +[**patch-auth-user**](#patch-auth-user) | **Patch** `/auth-users/{id}` | Auth user update ## get-auth-user -Auth User Details +Auth user details Return the specified user's authentication system details. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-user) @@ -91,7 +91,7 @@ func main() { [[Back to top]](#) ## patch-auth-user -Auth User Update +Auth user update Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignFiltersAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignFiltersAPI.md index 12e667eaa..0973c2efd 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignFiltersAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignFiltersAPI.md @@ -42,15 +42,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-campaign-filter**](#create-campaign-filter) | **Post** `/campaign-filters` | Create Campaign Filter -[**delete-campaign-filters**](#delete-campaign-filters) | **Post** `/campaign-filters/delete` | Deletes Campaign Filters -[**get-campaign-filter-by-id**](#get-campaign-filter-by-id) | **Get** `/campaign-filters/{id}` | Get Campaign Filter by ID -[**list-campaign-filters**](#list-campaign-filters) | **Get** `/campaign-filters` | List Campaign Filters -[**update-campaign-filter**](#update-campaign-filter) | **Post** `/campaign-filters/{id}` | Updates a Campaign Filter +[**create-campaign-filter**](#create-campaign-filter) | **Post** `/campaign-filters` | Create campaign filter +[**delete-campaign-filters**](#delete-campaign-filters) | **Post** `/campaign-filters/delete` | Deletes campaign filters +[**get-campaign-filter-by-id**](#get-campaign-filter-by-id) | **Get** `/campaign-filters/{id}` | Get campaign filter by id +[**list-campaign-filters**](#list-campaign-filters) | **Get** `/campaign-filters` | List campaign filters +[**update-campaign-filter**](#update-campaign-filter) | **Post** `/campaign-filters/{id}` | Updates a campaign filter ## create-campaign-filter -Create Campaign Filter +Create campaign filter Use this API to create a campaign filter based on filter details and criteria. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-campaign-filter) @@ -134,7 +134,7 @@ func main() { [[Back to top]](#) ## delete-campaign-filters -Deletes Campaign Filters +Deletes campaign filters Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-campaign-filters) @@ -200,7 +200,7 @@ func main() { [[Back to top]](#) ## get-campaign-filter-by-id -Get Campaign Filter by ID +Get campaign filter by id Retrieves information for an existing campaign filter using the filter's ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-campaign-filter-by-id) @@ -266,7 +266,7 @@ func main() { [[Back to top]](#) ## list-campaign-filters -List Campaign Filters +List campaign filters Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-campaign-filters) @@ -332,7 +332,7 @@ func main() { [[Back to top]](#) ## update-campaign-filter -Updates a Campaign Filter +Updates a campaign filter Updates an existing campaign filter using the filter's ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/update-campaign-filter) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignsAPI.md index b85688b7f..edabdb4e9 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignsAPI.md @@ -80,32 +80,32 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**complete-campaign**](#complete-campaign) | **Post** `/campaigns/{id}/complete` | Complete a Campaign +[**complete-campaign**](#complete-campaign) | **Post** `/campaigns/{id}/complete` | Complete a campaign [**create-campaign**](#create-campaign) | **Post** `/campaigns` | Create a campaign -[**create-campaign-template**](#create-campaign-template) | **Post** `/campaign-templates` | Create a Campaign Template -[**delete-campaign-template**](#delete-campaign-template) | **Delete** `/campaign-templates/{id}` | Delete a Campaign Template -[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **Delete** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule -[**delete-campaigns**](#delete-campaigns) | **Post** `/campaigns/delete` | Delete Campaigns -[**get-active-campaigns**](#get-active-campaigns) | **Get** `/campaigns` | List Campaigns -[**get-campaign**](#get-campaign) | **Get** `/campaigns/{id}` | Get Campaign -[**get-campaign-reports**](#get-campaign-reports) | **Get** `/campaigns/{id}/reports` | Get Campaign Reports -[**get-campaign-reports-config**](#get-campaign-reports-config) | **Get** `/campaigns/reports-configuration` | Get Campaign Reports Configuration -[**get-campaign-template**](#get-campaign-template) | **Get** `/campaign-templates/{id}` | Get a Campaign Template -[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **Get** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule -[**get-campaign-templates**](#get-campaign-templates) | **Get** `/campaign-templates` | List Campaign Templates -[**move**](#move) | **Post** `/campaigns/{id}/reassign` | Reassign Certifications -[**patch-campaign-template**](#patch-campaign-template) | **Patch** `/campaign-templates/{id}` | Update a Campaign Template -[**set-campaign-reports-config**](#set-campaign-reports-config) | **Put** `/campaigns/reports-configuration` | Set Campaign Reports Configuration -[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **Put** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule -[**start-campaign**](#start-campaign) | **Post** `/campaigns/{id}/activate` | Activate a Campaign -[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **Post** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan -[**start-campaign-report**](#start-campaign-report) | **Post** `/campaigns/{id}/run-report/{type}` | Run Campaign Report -[**start-generate-campaign-template**](#start-generate-campaign-template) | **Post** `/campaign-templates/{id}/generate` | Generate a Campaign from Template -[**update-campaign**](#update-campaign) | **Patch** `/campaigns/{id}` | Update a Campaign +[**create-campaign-template**](#create-campaign-template) | **Post** `/campaign-templates` | Create a campaign template +[**delete-campaign-template**](#delete-campaign-template) | **Delete** `/campaign-templates/{id}` | Delete a campaign template +[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **Delete** `/campaign-templates/{id}/schedule` | Delete campaign template schedule +[**delete-campaigns**](#delete-campaigns) | **Post** `/campaigns/delete` | Delete campaigns +[**get-active-campaigns**](#get-active-campaigns) | **Get** `/campaigns` | List campaigns +[**get-campaign**](#get-campaign) | **Get** `/campaigns/{id}` | Get campaign +[**get-campaign-reports**](#get-campaign-reports) | **Get** `/campaigns/{id}/reports` | Get campaign reports +[**get-campaign-reports-config**](#get-campaign-reports-config) | **Get** `/campaigns/reports-configuration` | Get campaign reports configuration +[**get-campaign-template**](#get-campaign-template) | **Get** `/campaign-templates/{id}` | Get a campaign template +[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **Get** `/campaign-templates/{id}/schedule` | Get campaign template schedule +[**get-campaign-templates**](#get-campaign-templates) | **Get** `/campaign-templates` | List campaign templates +[**move**](#move) | **Post** `/campaigns/{id}/reassign` | Reassign certifications +[**patch-campaign-template**](#patch-campaign-template) | **Patch** `/campaign-templates/{id}` | Update a campaign template +[**set-campaign-reports-config**](#set-campaign-reports-config) | **Put** `/campaigns/reports-configuration` | Set campaign reports configuration +[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **Put** `/campaign-templates/{id}/schedule` | Set campaign template schedule +[**start-campaign**](#start-campaign) | **Post** `/campaigns/{id}/activate` | Activate a campaign +[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **Post** `/campaigns/{id}/run-remediation-scan` | Run campaign remediation scan +[**start-campaign-report**](#start-campaign-report) | **Post** `/campaigns/{id}/run-report/{type}` | Run campaign report +[**start-generate-campaign-template**](#start-generate-campaign-template) | **Post** `/campaign-templates/{id}/generate` | Generate a campaign from template +[**update-campaign**](#update-campaign) | **Patch** `/campaigns/{id}` | Update a campaign ## complete-campaign -Complete a Campaign +Complete a campaign :::caution This endpoint will run successfully for any campaigns that are **past due**. @@ -362,7 +362,7 @@ func main() { [[Back to top]](#) ## create-campaign-template -Create a Campaign Template +Create a campaign template Use this API to create a certification campaign template based on campaign. @@ -555,7 +555,7 @@ func main() { [[Back to top]](#) ## delete-campaign-template -Delete a Campaign Template +Delete a campaign template Use this API to delete a certification campaign template by ID. @@ -621,7 +621,7 @@ func main() { [[Back to top]](#) ## delete-campaign-template-schedule -Delete Campaign Template Schedule +Delete campaign template schedule Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. @@ -687,7 +687,7 @@ func main() { [[Back to top]](#) ## delete-campaigns -Delete Campaigns +Delete campaigns Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. @@ -757,7 +757,7 @@ func main() { [[Back to top]](#) ## get-active-campaigns -List Campaigns +List campaigns Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. @@ -830,7 +830,7 @@ func main() { [[Back to top]](#) ## get-campaign -Get Campaign +Get campaign Use this API to get information for an existing certification campaign by the campaign's ID. @@ -899,7 +899,7 @@ func main() { [[Back to top]](#) ## get-campaign-reports -Get Campaign Reports +Get campaign reports Use this API to fetch all reports for a certification campaign by campaign ID. @@ -966,7 +966,7 @@ func main() { [[Back to top]](#) ## get-campaign-reports-config -Get Campaign Reports Configuration +Get campaign reports configuration Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. @@ -1024,7 +1024,7 @@ func main() { [[Back to top]](#) ## get-campaign-template -Get a Campaign Template +Get a campaign template Use this API to fetch a certification campaign template by ID. @@ -1091,7 +1091,7 @@ func main() { [[Back to top]](#) ## get-campaign-template-schedule -Get Campaign Template Schedule +Get campaign template schedule Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. @@ -1158,7 +1158,7 @@ func main() { [[Back to top]](#) ## get-campaign-templates -List Campaign Templates +List campaign templates Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. @@ -1231,7 +1231,7 @@ func main() { [[Back to top]](#) ## move -Reassign Certifications +Reassign certifications This API reassigns the specified certifications from one identity to another. @@ -1312,7 +1312,7 @@ func main() { [[Back to top]](#) ## patch-campaign-template -Update a Campaign Template +Update a campaign template Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. @@ -1386,7 +1386,7 @@ func main() { [[Back to top]](#) ## set-campaign-reports-config -Set Campaign Reports Configuration +Set campaign reports configuration Use this API to overwrite the configuration for campaign reports. @@ -1456,7 +1456,7 @@ func main() { [[Back to top]](#) ## set-campaign-template-schedule -Set Campaign Template Schedule +Set campaign template schedule Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. @@ -1543,7 +1543,7 @@ func main() { [[Back to top]](#) ## start-campaign -Activate a Campaign +Activate a campaign Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. @@ -1614,7 +1614,7 @@ func main() { [[Back to top]](#) ## start-campaign-remediation-scan -Run Campaign Remediation Scan +Run campaign remediation scan Use this API to run a remediation scan task for a certification campaign. @@ -1681,7 +1681,7 @@ func main() { [[Back to top]](#) ## start-campaign-report -Run Campaign Report +Run campaign report Use this API to run a report for a certification campaign. @@ -1751,7 +1751,7 @@ func main() { [[Back to top]](#) ## start-generate-campaign-template -Generate a Campaign from Template +Generate a campaign from template Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description @@ -1828,7 +1828,7 @@ func main() { [[Back to top]](#) ## update-campaign -Update a Campaign +Update a campaign Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/CertificationSummariesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationSummariesAPI.md index 7b8a27856..deab7e998 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/CertificationSummariesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationSummariesAPI.md @@ -29,14 +29,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-identity-access-summaries**](#get-identity-access-summaries) | **Get** `/certifications/{id}/access-summaries/{type}` | Access Summaries -[**get-identity-decision-summary**](#get-identity-decision-summary) | **Get** `/certifications/{id}/decision-summary` | Summary of Certification Decisions -[**get-identity-summaries**](#get-identity-summaries) | **Get** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification -[**get-identity-summary**](#get-identity-summary) | **Get** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity +[**get-identity-access-summaries**](#get-identity-access-summaries) | **Get** `/certifications/{id}/access-summaries/{type}` | Access summaries +[**get-identity-decision-summary**](#get-identity-decision-summary) | **Get** `/certifications/{id}/decision-summary` | Summary of certification decisions +[**get-identity-summaries**](#get-identity-summaries) | **Get** `/certifications/{id}/identity-summaries` | Identity summaries for campaign certification +[**get-identity-summary**](#get-identity-summary) | **Get** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for identity ## get-identity-access-summaries -Access Summaries +Access summaries This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-access-summaries) @@ -115,7 +115,7 @@ func main() { [[Back to top]](#) ## get-identity-decision-summary -Summary of Certification Decisions +Summary of certification decisions This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-decision-summary) @@ -183,7 +183,7 @@ func main() { [[Back to top]](#) ## get-identity-summaries -Identity Summaries for Campaign Certification +Identity summaries for campaign certification This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-summaries) @@ -259,7 +259,7 @@ func main() { [[Back to top]](#) ## get-identity-summary -Summary for Identity +Summary for identity This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-summary) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/CertificationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationsAPI.md index e3bc288e6..ac0e4828c 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/CertificationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationsAPI.md @@ -38,21 +38,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-certification-task**](#get-certification-task) | **Get** `/certification-tasks/{id}` | Certification Task by ID -[**get-identity-certification**](#get-identity-certification) | **Get** `/certifications/{id}` | Identity Certification by ID -[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **Get** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item -[**get-pending-certification-tasks**](#get-pending-certification-tasks) | **Get** `/certification-tasks` | List of Pending Certification Tasks -[**list-certification-reviewers**](#list-certification-reviewers) | **Get** `/certifications/{id}/reviewers` | List of Reviewers for certification -[**list-identity-access-review-items**](#list-identity-access-review-items) | **Get** `/certifications/{id}/access-review-items` | List of Access Review Items -[**list-identity-certifications**](#list-identity-certifications) | **Get** `/certifications` | List Identity Campaign Certifications -[**make-identity-decision**](#make-identity-decision) | **Post** `/certifications/{id}/decide` | Decide on a Certification Item -[**reassign-identity-certifications**](#reassign-identity-certifications) | **Post** `/certifications/{id}/reassign` | Reassign Identities or Items -[**sign-off-identity-certification**](#sign-off-identity-certification) | **Post** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions -[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **Post** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously +[**get-certification-task**](#get-certification-task) | **Get** `/certification-tasks/{id}` | Certification task by id +[**get-identity-certification**](#get-identity-certification) | **Get** `/certifications/{id}` | Identity certification by id +[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **Get** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for entitlement certification item +[**get-pending-certification-tasks**](#get-pending-certification-tasks) | **Get** `/certification-tasks` | List of pending certification tasks +[**list-certification-reviewers**](#list-certification-reviewers) | **Get** `/certifications/{id}/reviewers` | List of reviewers for certification +[**list-identity-access-review-items**](#list-identity-access-review-items) | **Get** `/certifications/{id}/access-review-items` | List of access review items +[**list-identity-certifications**](#list-identity-certifications) | **Get** `/certifications` | List identity campaign certifications +[**make-identity-decision**](#make-identity-decision) | **Post** `/certifications/{id}/decide` | Decide on a certification item +[**reassign-identity-certifications**](#reassign-identity-certifications) | **Post** `/certifications/{id}/reassign` | Reassign identities or items +[**sign-off-identity-certification**](#sign-off-identity-certification) | **Post** `/certifications/{id}/sign-off` | Finalize identity certification decisions +[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **Post** `/certifications/{id}/reassign-async` | Reassign certifications asynchronously ## get-certification-task -Certification Task by ID +Certification task by id This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-certification-task) @@ -118,7 +118,7 @@ func main() { [[Back to top]](#) ## get-identity-certification -Identity Certification by ID +Identity certification by id This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-certification) @@ -184,7 +184,7 @@ func main() { [[Back to top]](#) ## get-identity-certification-item-permissions -Permissions for Entitlement Certification Item +Permissions for entitlement certification item This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-certification-item-permissions) @@ -261,7 +261,7 @@ func main() { [[Back to top]](#) ## get-pending-certification-tasks -List of Pending Certification Tasks +List of pending certification tasks This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-pending-certification-tasks) @@ -331,7 +331,7 @@ func main() { [[Back to top]](#) ## list-certification-reviewers -List of Reviewers for certification +List of reviewers for certification This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-certification-reviewers) @@ -407,7 +407,7 @@ func main() { [[Back to top]](#) ## list-identity-access-review-items -List of Access Review Items +List of access review items This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-identity-access-review-items) @@ -489,7 +489,7 @@ func main() { [[Back to top]](#) ## list-identity-certifications -List Identity Campaign Certifications +List identity campaign certifications Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-identity-certifications) @@ -561,7 +561,7 @@ func main() { [[Back to top]](#) ## make-identity-decision -Decide on a Certification Item +Decide on a certification item The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v2025/make-identity-decision) @@ -634,7 +634,7 @@ func main() { [[Back to top]](#) ## reassign-identity-certifications -Reassign Identities or Items +Reassign identities or items This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v2025/reassign-identity-certifications) @@ -717,7 +717,7 @@ func main() { [[Back to top]](#) ## sign-off-identity-certification -Finalize Identity Certification Decisions +Finalize identity certification decisions This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v2025/sign-off-identity-certification) @@ -783,7 +783,7 @@ func main() { [[Back to top]](#) ## submit-reassign-certs-async -Reassign Certifications Asynchronously +Reassign certifications asynchronously This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ConfigurationHubAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ConfigurationHubAPI.md index 3c9497d92..dee66405a 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/ConfigurationHubAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ConfigurationHubAPI.md @@ -26,30 +26,30 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-deploy**](#create-deploy) | **Post** `/configuration-hub/deploys` | Create a Deploy +[**create-deploy**](#create-deploy) | **Post** `/configuration-hub/deploys` | Create a deploy [**create-object-mapping**](#create-object-mapping) | **Post** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping [**create-object-mappings**](#create-object-mappings) | **Post** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings -[**create-scheduled-action**](#create-scheduled-action) | **Post** `/configuration-hub/scheduled-actions` | Create Scheduled Action -[**create-uploaded-configuration**](#create-uploaded-configuration) | **Post** `/configuration-hub/backups/uploads` | Upload a Configuration -[**delete-backup**](#delete-backup) | **Delete** `/configuration-hub/backups/{id}` | Delete a Backup +[**create-scheduled-action**](#create-scheduled-action) | **Post** `/configuration-hub/scheduled-actions` | Create scheduled action +[**create-uploaded-configuration**](#create-uploaded-configuration) | **Post** `/configuration-hub/backups/uploads` | Upload a configuration +[**delete-backup**](#delete-backup) | **Delete** `/configuration-hub/backups/{id}` | Delete a backup [**delete-draft**](#delete-draft) | **Delete** `/configuration-hub/drafts/{id}` | Delete a draft [**delete-object-mapping**](#delete-object-mapping) | **Delete** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping -[**delete-scheduled-action**](#delete-scheduled-action) | **Delete** `/configuration-hub/scheduled-actions/{id}` | Delete Scheduled Action -[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **Delete** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration -[**get-deploy**](#get-deploy) | **Get** `/configuration-hub/deploys/{id}` | Get a Deploy +[**delete-scheduled-action**](#delete-scheduled-action) | **Delete** `/configuration-hub/scheduled-actions/{id}` | Delete scheduled action +[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **Delete** `/configuration-hub/backups/uploads/{id}` | Delete an uploaded configuration +[**get-deploy**](#get-deploy) | **Get** `/configuration-hub/deploys/{id}` | Get a deploy [**get-object-mappings**](#get-object-mappings) | **Get** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings -[**get-uploaded-configuration**](#get-uploaded-configuration) | **Get** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration -[**list-backups**](#list-backups) | **Get** `/configuration-hub/backups` | List Backups -[**list-deploys**](#list-deploys) | **Get** `/configuration-hub/deploys` | List Deploys -[**list-drafts**](#list-drafts) | **Get** `/configuration-hub/drafts` | List Drafts -[**list-scheduled-actions**](#list-scheduled-actions) | **Get** `/configuration-hub/scheduled-actions` | List Scheduled Actions -[**list-uploaded-configurations**](#list-uploaded-configurations) | **Get** `/configuration-hub/backups/uploads` | List Uploaded Configurations +[**get-uploaded-configuration**](#get-uploaded-configuration) | **Get** `/configuration-hub/backups/uploads/{id}` | Get an uploaded configuration +[**list-backups**](#list-backups) | **Get** `/configuration-hub/backups` | List backups +[**list-deploys**](#list-deploys) | **Get** `/configuration-hub/deploys` | List deploys +[**list-drafts**](#list-drafts) | **Get** `/configuration-hub/drafts` | List drafts +[**list-scheduled-actions**](#list-scheduled-actions) | **Get** `/configuration-hub/scheduled-actions` | List scheduled actions +[**list-uploaded-configurations**](#list-uploaded-configurations) | **Get** `/configuration-hub/backups/uploads` | List uploaded configurations [**update-object-mappings**](#update-object-mappings) | **Post** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings -[**update-scheduled-action**](#update-scheduled-action) | **Patch** `/configuration-hub/scheduled-actions/{id}` | Update Scheduled Action +[**update-scheduled-action**](#update-scheduled-action) | **Patch** `/configuration-hub/scheduled-actions/{id}` | Update scheduled action ## create-deploy -Create a Deploy +Create a deploy This API performs a deploy based on an existing daft. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-deploy) @@ -290,7 +290,7 @@ func main() { [[Back to top]](#) ## create-scheduled-action -Create Scheduled Action +Create scheduled action This API creates a new scheduled action for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-scheduled-action) @@ -379,7 +379,7 @@ func main() { [[Back to top]](#) ## create-uploaded-configuration -Upload a Configuration +Upload a configuration This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. @@ -447,7 +447,7 @@ func main() { [[Back to top]](#) ## delete-backup -Delete a Backup +Delete a backup This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. @@ -656,7 +656,7 @@ func main() { [[Back to top]](#) ## delete-scheduled-action -Delete Scheduled Action +Delete scheduled action This API deletes an existing scheduled action. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-scheduled-action) @@ -721,7 +721,7 @@ func main() { [[Back to top]](#) ## delete-uploaded-configuration -Delete an Uploaded Configuration +Delete an uploaded configuration This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. @@ -790,7 +790,7 @@ func main() { [[Back to top]](#) ## get-deploy -Get a Deploy +Get a deploy This API gets an existing deploy for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-deploy) @@ -925,7 +925,7 @@ func main() { [[Back to top]](#) ## get-uploaded-configuration -Get an Uploaded Configuration +Get an uploaded configuration This API gets an existing uploaded configuration for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-uploaded-configuration) @@ -991,7 +991,7 @@ func main() { [[Back to top]](#) ## list-backups -List Backups +List backups This API gets a list of existing backups for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-backups) @@ -1053,7 +1053,7 @@ func main() { [[Back to top]](#) ## list-deploys -List Deploys +List deploys This API gets a list of deploys for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-deploys) @@ -1110,7 +1110,7 @@ func main() { [[Back to top]](#) ## list-drafts -List Drafts +List drafts This API gets a list of existing drafts for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-drafts) @@ -1172,7 +1172,7 @@ func main() { [[Back to top]](#) ## list-scheduled-actions -List Scheduled Actions +List scheduled actions This API gets a list of existing scheduled actions for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-scheduled-actions) @@ -1229,7 +1229,7 @@ func main() { [[Back to top]](#) ## list-uploaded-configurations -List Uploaded Configurations +List uploaded configurations This API gets a list of existing uploaded configurations for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-uploaded-configurations) @@ -1380,7 +1380,7 @@ func main() { [[Back to top]](#) ## update-scheduled-action -Update Scheduled Action +Update scheduled action This API updates an existing scheduled action using JSON Patch format. [API Spec](https://developer.sailpoint.com/docs/api/v2025/update-scheduled-action) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorCustomizersAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorCustomizersAPI.md index 5476ad3e1..c4fac9b66 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorCustomizersAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorCustomizersAPI.md @@ -18,16 +18,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-connector-customizer**](#create-connector-customizer) | **Post** `/connector-customizers` | Create Connector Customizer +[**create-connector-customizer**](#create-connector-customizer) | **Post** `/connector-customizers` | Create connector customizer [**create-connector-customizer-version**](#create-connector-customizer-version) | **Post** `/connector-customizers/{id}/versions` | Creates a connector customizer version -[**delete-connector-customizer**](#delete-connector-customizer) | **Delete** `/connector-customizers/{id}` | Delete Connector Customizer +[**delete-connector-customizer**](#delete-connector-customizer) | **Delete** `/connector-customizers/{id}` | Delete connector customizer [**get-connector-customizer**](#get-connector-customizer) | **Get** `/connector-customizers/{id}` | Get connector customizer -[**list-connector-customizers**](#list-connector-customizers) | **Get** `/connector-customizers` | List All Connector Customizers -[**put-connector-customizer**](#put-connector-customizer) | **Put** `/connector-customizers/{id}` | Update Connector Customizer +[**list-connector-customizers**](#list-connector-customizers) | **Get** `/connector-customizers` | List all connector customizers +[**put-connector-customizer**](#put-connector-customizer) | **Put** `/connector-customizers/{id}` | Update connector customizer ## create-connector-customizer -Create Connector Customizer +Create connector customizer Create a connector customizer. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-connector-customizer) @@ -162,7 +162,7 @@ func main() { [[Back to top]](#) ## delete-connector-customizer -Delete Connector Customizer +Delete connector customizer Delete the connector customizer for the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-connector-customizer) @@ -293,7 +293,7 @@ func main() { [[Back to top]](#) ## list-connector-customizers -List All Connector Customizers +List all connector customizers List all connector customizers. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-connector-customizers) @@ -357,7 +357,7 @@ func main() { [[Back to top]](#) ## put-connector-customizer -Update Connector Customizer +Update connector customizer Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-connector-customizer) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorRuleManagementAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorRuleManagementAPI.md index 0f4c05081..61f7b7b16 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorRuleManagementAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorRuleManagementAPI.md @@ -22,16 +22,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-connector-rule**](#create-connector-rule) | **Post** `/connector-rules` | Create Connector Rule -[**delete-connector-rule**](#delete-connector-rule) | **Delete** `/connector-rules/{id}` | Delete Connector Rule -[**get-connector-rule**](#get-connector-rule) | **Get** `/connector-rules/{id}` | Get Connector Rule -[**get-connector-rule-list**](#get-connector-rule-list) | **Get** `/connector-rules` | List Connector Rules -[**put-connector-rule**](#put-connector-rule) | **Put** `/connector-rules/{id}` | Update Connector Rule -[**test-connector-rule**](#test-connector-rule) | **Post** `/connector-rules/validate` | Validate Connector Rule +[**create-connector-rule**](#create-connector-rule) | **Post** `/connector-rules` | Create connector rule +[**delete-connector-rule**](#delete-connector-rule) | **Delete** `/connector-rules/{id}` | Delete connector rule +[**get-connector-rule**](#get-connector-rule) | **Get** `/connector-rules/{id}` | Get connector rule +[**get-connector-rule-list**](#get-connector-rule-list) | **Get** `/connector-rules` | List connector rules +[**put-connector-rule**](#put-connector-rule) | **Put** `/connector-rules/{id}` | Update connector rule +[**test-connector-rule**](#test-connector-rule) | **Post** `/connector-rules/validate` | Validate connector rule ## create-connector-rule -Create Connector Rule +Create connector rule Create a connector rule from the available types. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-connector-rule) @@ -123,7 +123,7 @@ func main() { [[Back to top]](#) ## delete-connector-rule -Delete Connector Rule +Delete connector rule Delete the connector rule for the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-connector-rule) @@ -188,7 +188,7 @@ func main() { [[Back to top]](#) ## get-connector-rule -Get Connector Rule +Get connector rule Get a connector rule by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-rule) @@ -254,7 +254,7 @@ func main() { [[Back to top]](#) ## get-connector-rule-list -List Connector Rules +List connector rules List existing connector rules. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-rule-list) @@ -320,7 +320,7 @@ func main() { [[Back to top]](#) ## put-connector-rule -Update Connector Rule +Update connector rule Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-connector-rule) @@ -414,7 +414,7 @@ func main() { [[Back to top]](#) ## test-connector-rule -Validate Connector Rule +Validate connector rule Detect issues within the connector rule's code to fix and list them. [API Spec](https://developer.sailpoint.com/docs/api/v2025/test-connector-rule) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorsAPI.md index 9ea313ce9..13fd9b41b 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorsAPI.md @@ -29,23 +29,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-custom-connector**](#create-custom-connector) | **Post** `/connectors` | Create Custom Connector -[**delete-custom-connector**](#delete-custom-connector) | **Delete** `/connectors/{scriptName}` | Delete Connector by Script Name -[**get-connector**](#get-connector) | **Get** `/connectors/{scriptName}` | Get Connector by Script Name -[**get-connector-correlation-config**](#get-connector-correlation-config) | **Get** `/connectors/{scriptName}/correlation-config` | Get Connector Correlation Configuration -[**get-connector-list**](#get-connector-list) | **Get** `/connectors` | Get Connector List -[**get-connector-source-config**](#get-connector-source-config) | **Get** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration -[**get-connector-source-template**](#get-connector-source-template) | **Get** `/connectors/{scriptName}/source-template` | Get Connector Source Template -[**get-connector-translations**](#get-connector-translations) | **Get** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations -[**put-connector-correlation-config**](#put-connector-correlation-config) | **Put** `/connectors/{scriptName}/correlation-config` | Update Connector Correlation Configuration -[**put-connector-source-config**](#put-connector-source-config) | **Put** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration -[**put-connector-source-template**](#put-connector-source-template) | **Put** `/connectors/{scriptName}/source-template` | Update Connector Source Template -[**put-connector-translations**](#put-connector-translations) | **Put** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations -[**update-connector**](#update-connector) | **Patch** `/connectors/{scriptName}` | Update Connector by Script Name +[**create-custom-connector**](#create-custom-connector) | **Post** `/connectors` | Create custom connector +[**delete-custom-connector**](#delete-custom-connector) | **Delete** `/connectors/{scriptName}` | Delete connector by script name +[**get-connector**](#get-connector) | **Get** `/connectors/{scriptName}` | Get connector by script name +[**get-connector-correlation-config**](#get-connector-correlation-config) | **Get** `/connectors/{scriptName}/correlation-config` | Get connector correlation configuration +[**get-connector-list**](#get-connector-list) | **Get** `/connectors` | Get connector list +[**get-connector-source-config**](#get-connector-source-config) | **Get** `/connectors/{scriptName}/source-config` | Get connector source configuration +[**get-connector-source-template**](#get-connector-source-template) | **Get** `/connectors/{scriptName}/source-template` | Get connector source template +[**get-connector-translations**](#get-connector-translations) | **Get** `/connectors/{scriptName}/translations/{locale}` | Get connector translations +[**put-connector-correlation-config**](#put-connector-correlation-config) | **Put** `/connectors/{scriptName}/correlation-config` | Update connector correlation configuration +[**put-connector-source-config**](#put-connector-source-config) | **Put** `/connectors/{scriptName}/source-config` | Update connector source configuration +[**put-connector-source-template**](#put-connector-source-template) | **Put** `/connectors/{scriptName}/source-template` | Update connector source template +[**put-connector-translations**](#put-connector-translations) | **Put** `/connectors/{scriptName}/translations/{locale}` | Update connector translations +[**update-connector**](#update-connector) | **Patch** `/connectors/{scriptName}` | Update connector by script name ## create-custom-connector -Create Custom Connector +Create custom connector Create custom connector. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-custom-connector) @@ -118,7 +118,7 @@ func main() { [[Back to top]](#) ## delete-custom-connector -Delete Connector by Script Name +Delete connector by script name Delete a custom connector that using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-custom-connector) @@ -183,7 +183,7 @@ func main() { [[Back to top]](#) ## get-connector -Get Connector by Script Name +Get connector by script name Fetches a connector that using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector) @@ -251,7 +251,7 @@ func main() { [[Back to top]](#) ## get-connector-correlation-config -Get Connector Correlation Configuration +Get connector correlation configuration Fetches a connector's correlation config using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-correlation-config) @@ -317,7 +317,7 @@ func main() { [[Back to top]](#) ## get-connector-list -Get Connector List +Get connector list Fetches list of connectors that have 'RELEASED' status using filtering and pagination. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-list) @@ -387,7 +387,7 @@ func main() { [[Back to top]](#) ## get-connector-source-config -Get Connector Source Configuration +Get connector source configuration Fetches a connector's source config using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-source-config) @@ -453,7 +453,7 @@ func main() { [[Back to top]](#) ## get-connector-source-template -Get Connector Source Template +Get connector source template Fetches a connector's source template using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-source-template) @@ -519,7 +519,7 @@ func main() { [[Back to top]](#) ## get-connector-translations -Get Connector Translations +Get connector translations Fetches a connector's translations using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-translations) @@ -588,7 +588,7 @@ func main() { [[Back to top]](#) ## put-connector-correlation-config -Update Connector Correlation Configuration +Update connector correlation configuration Update a connector's correlation config using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-connector-correlation-config) @@ -656,7 +656,7 @@ func main() { [[Back to top]](#) ## put-connector-source-config -Update Connector Source Configuration +Update connector source configuration Update a connector's source config using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-connector-source-config) @@ -724,7 +724,7 @@ func main() { [[Back to top]](#) ## put-connector-source-template -Update Connector Source Template +Update connector source template Update a connector's source template using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-connector-source-template) @@ -792,7 +792,7 @@ func main() { [[Back to top]](#) ## put-connector-translations -Update Connector Translations +Update connector translations Update a connector's translations using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-connector-translations) @@ -861,7 +861,7 @@ func main() { [[Back to top]](#) ## update-connector -Update Connector by Script Name +Update connector by script name This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/CustomFormsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/CustomFormsAPI.md index 20db6c2e3..7a19db48b 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/CustomFormsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/CustomFormsAPI.md @@ -24,15 +24,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-form-definition**](#create-form-definition) | **Post** `/form-definitions` | Creates a form definition. -[**create-form-definition-dynamic-schema**](#create-form-definition-dynamic-schema) | **Post** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically. +[**create-form-definition-dynamic-schema**](#create-form-definition-dynamic-schema) | **Post** `/form-definitions/forms-action-dynamic-schema` | Generate json schema dynamically. [**create-form-definition-file-request**](#create-form-definition-file-request) | **Post** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file. [**create-form-instance**](#create-form-instance) | **Post** `/form-instances` | Creates a form instance. [**delete-form-definition**](#delete-form-definition) | **Delete** `/form-definitions/{formDefinitionID}` | Deletes a form definition. [**export-form-definitions-by-tenant**](#export-form-definitions-by-tenant) | **Get** `/form-definitions/export` | List form definitions by tenant. -[**get-file-from-s3**](#get-file-from-s3) | **Get** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId. +[**get-file-from-s3**](#get-file-from-s3) | **Get** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileid. [**get-form-definition-by-key**](#get-form-definition-by-key) | **Get** `/form-definitions/{formDefinitionID}` | Return a form definition. [**get-form-instance-by-key**](#get-form-instance-by-key) | **Get** `/form-instances/{formInstanceID}` | Returns a form instance. -[**get-form-instance-file**](#get-form-instance-file) | **Get** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId. +[**get-form-instance-file**](#get-form-instance-file) | **Get** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileid. [**import-form-definitions**](#import-form-definitions) | **Post** `/form-definitions/import` | Import form definitions from export. [**patch-form-definition**](#patch-form-definition) | **Patch** `/form-definitions/{formDefinitionID}` | Patch a form definition. [**patch-form-instance**](#patch-form-instance) | **Patch** `/form-instances/{formInstanceID}` | Patch a form instance. @@ -216,7 +216,7 @@ func main() { [[Back to top]](#) ## create-form-definition-dynamic-schema -Generate JSON Schema dynamically. +Generate json schema dynamically. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-form-definition-dynamic-schema) @@ -570,7 +570,7 @@ func main() { [[Back to top]](#) ## get-file-from-s3 -Download definition file by fileId. +Download definition file by fileid. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-file-from-s3) @@ -771,7 +771,7 @@ func main() { [[Back to top]](#) ## get-form-instance-file -Download instance file by fileId. +Download instance file by fileid. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-form-instance-file) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/CustomPasswordInstructionsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/CustomPasswordInstructionsAPI.md index b4ed870ec..ef0dc5267 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/CustomPasswordInstructionsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/CustomPasswordInstructionsAPI.md @@ -26,9 +26,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-custom-password-instructions**](#create-custom-password-instructions) | **Post** `/custom-password-instructions` | Create Custom Password Instructions -[**delete-custom-password-instructions**](#delete-custom-password-instructions) | **Delete** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID -[**get-custom-password-instructions**](#get-custom-password-instructions) | **Get** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID +[**create-custom-password-instructions**](#create-custom-password-instructions) | **Post** `/custom-password-instructions` | Create custom password instructions +[**delete-custom-password-instructions**](#delete-custom-password-instructions) | **Delete** `/custom-password-instructions/{pageId}` | Delete custom password instructions by page id +[**get-custom-password-instructions**](#get-custom-password-instructions) | **Get** `/custom-password-instructions/{pageId}` | Get custom password instructions by page id ## create-custom-password-instructions @@ -43,7 +43,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create Custom Password Instructions +Create custom password instructions This API creates the custom password instructions for the specified page ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-custom-password-instructions) @@ -127,7 +127,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Custom Password Instructions by page ID +Delete custom password instructions by page id This API delete the custom password instructions for the specified page ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-custom-password-instructions) @@ -207,7 +207,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Custom Password Instructions by Page ID +Get custom password instructions by page id This API returns the custom password instructions for the specified page ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-custom-password-instructions) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/DataSegmentationAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/DataSegmentationAPI.md index 6c84d3a02..c0a18d43c 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/DataSegmentationAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/DataSegmentationAPI.md @@ -17,18 +17,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-data-segment**](#create-data-segment) | **Post** `/data-segments` | Create Segment -[**delete-data-segment**](#delete-data-segment) | **Delete** `/data-segments/{segmentId}` | Delete Segment by ID -[**get-data-segment**](#get-data-segment) | **Get** `/data-segments/{segmentId}` | Get Segment by ID -[**get-data-segment-identity-membership**](#get-data-segment-identity-membership) | **Get** `/data-segments/membership/{identityId}` | Get SegmentMembership by Identity ID -[**get-data-segmentation-enabled-for-user**](#get-data-segmentation-enabled-for-user) | **Get** `/data-segments/user-enabled/{identityId}` | Is Segmentation enabled by Identity -[**list-data-segments**](#list-data-segments) | **Get** `/data-segments` | Get Segments -[**patch-data-segment**](#patch-data-segment) | **Patch** `/data-segments/{segmentId}` | Update Segment -[**publish-data-segment**](#publish-data-segment) | **Post** `/data-segments/{segmentId}` | Publish segment by ID +[**create-data-segment**](#create-data-segment) | **Post** `/data-segments` | Create segment +[**delete-data-segment**](#delete-data-segment) | **Delete** `/data-segments/{segmentId}` | Delete segment by id +[**get-data-segment**](#get-data-segment) | **Get** `/data-segments/{segmentId}` | Get segment by id +[**get-data-segment-identity-membership**](#get-data-segment-identity-membership) | **Get** `/data-segments/membership/{identityId}` | Get segmentmembership by identity id +[**get-data-segmentation-enabled-for-user**](#get-data-segmentation-enabled-for-user) | **Get** `/data-segments/user-enabled/{identityId}` | Is segmentation enabled by identity +[**list-data-segments**](#list-data-segments) | **Get** `/data-segments` | Get segments +[**patch-data-segment**](#patch-data-segment) | **Patch** `/data-segments/{segmentId}` | Update segment +[**publish-data-segment**](#publish-data-segment) | **Post** `/data-segments/{segmentId}` | Publish segment by id ## create-data-segment -Create Segment +Create segment This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. @@ -107,7 +107,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Segment by ID +Delete segment by id This API deletes the segment specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-data-segment) @@ -187,7 +187,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Segment by ID +Get segment by id This API returns the segment specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-data-segment) @@ -266,7 +266,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get SegmentMembership by Identity ID +Get segmentmembership by identity id This API returns the segment membership specified by the given identity ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-data-segment-identity-membership) @@ -345,7 +345,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Is Segmentation enabled by Identity +Is segmentation enabled by identity This API returns whether or not segmentation is enabled for the identity. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-data-segmentation-enabled-for-user) @@ -424,7 +424,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Segments +Get segments This API returns the segment specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-data-segments) @@ -511,7 +511,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Segment +Update segment Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. [API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-data-segment) @@ -597,7 +597,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Publish segment by ID +Publish segment by id This will publish the segment so that it starts applying the segmentation to the desired users if enabled [API Spec](https://developer.sailpoint.com/docs/api/v2025/publish-data-segment) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/DimensionsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/DimensionsAPI.md index 22a3877cf..0afb44b45 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/DimensionsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/DimensionsAPI.md @@ -16,18 +16,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-dimension**](#create-dimension) | **Post** `/roles/{roleId}/dimensions` | Create a Dimension -[**delete-bulk-dimensions**](#delete-bulk-dimensions) | **Post** `/roles/{roleId}/dimensions/bulk-delete` | Delete Dimension(s) -[**delete-dimension**](#delete-dimension) | **Delete** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a Dimension -[**get-dimension**](#get-dimension) | **Get** `/roles/{roleId}/dimensions/{dimensionId}` | Get a Dimension under Role. -[**get-dimension-entitlements**](#get-dimension-entitlements) | **Get** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List Dimension's Entitlements -[**list-dimension-access-profiles**](#list-dimension-access-profiles) | **Get** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List Dimension's Access Profiles -[**list-dimensions**](#list-dimensions) | **Get** `/roles/{roleId}/dimensions` | List Dimensions -[**patch-dimension**](#patch-dimension) | **Patch** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified Dimension +[**create-dimension**](#create-dimension) | **Post** `/roles/{roleId}/dimensions` | Create a dimension +[**delete-bulk-dimensions**](#delete-bulk-dimensions) | **Post** `/roles/{roleId}/dimensions/bulk-delete` | Delete dimension(s) +[**delete-dimension**](#delete-dimension) | **Delete** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a dimension +[**get-dimension**](#get-dimension) | **Get** `/roles/{roleId}/dimensions/{dimensionId}` | Get a dimension under role. +[**get-dimension-entitlements**](#get-dimension-entitlements) | **Get** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List dimension's entitlements +[**list-dimension-access-profiles**](#list-dimension-access-profiles) | **Get** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List dimension's access profiles +[**list-dimensions**](#list-dimensions) | **Get** `/roles/{roleId}/dimensions` | List dimensions +[**patch-dimension**](#patch-dimension) | **Patch** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified dimension ## create-dimension -Create a Dimension +Create a dimension This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. @@ -189,7 +189,7 @@ func main() { [[Back to top]](#) ## delete-bulk-dimensions -Delete Dimension(s) +Delete dimension(s) This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. @@ -267,7 +267,7 @@ func main() { [[Back to top]](#) ## delete-dimension -Delete a Dimension +Delete a dimension This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. @@ -336,7 +336,7 @@ func main() { [[Back to top]](#) ## get-dimension -Get a Dimension under Role. +Get a dimension under role. This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. @@ -407,7 +407,7 @@ func main() { [[Back to top]](#) ## get-dimension-entitlements -List Dimension's Entitlements +List dimension's entitlements This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. @@ -488,7 +488,7 @@ func main() { [[Back to top]](#) ## list-dimension-access-profiles -List Dimension's Access Profiles +List dimension's access profiles This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. @@ -569,7 +569,7 @@ func main() { [[Back to top]](#) ## list-dimensions -List Dimensions +List dimensions This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. @@ -649,7 +649,7 @@ func main() { [[Back to top]](#) ## patch-dimension -Patch a specified Dimension +Patch a specified dimension This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/EntitlementsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/EntitlementsAPI.md index c1621d917..0bdd3c1c3 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/EntitlementsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/EntitlementsAPI.md @@ -67,14 +67,14 @@ Method | HTTP request | Description [**create-access-model-metadata-for-entitlement**](#create-access-model-metadata-for-entitlement) | **Post** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. [**delete-access-model-metadata-from-entitlement**](#delete-access-model-metadata-from-entitlement) | **Delete** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. [**get-entitlement**](#get-entitlement) | **Get** `/entitlements/{id}` | Get an entitlement -[**get-entitlement-request-config**](#get-entitlement-request-config) | **Get** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config -[**import-entitlements-by-source**](#import-entitlements-by-source) | **Post** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements +[**get-entitlement-request-config**](#get-entitlement-request-config) | **Get** `/entitlements/{id}/entitlement-request-config` | Get entitlement request config +[**import-entitlements-by-source**](#import-entitlements-by-source) | **Post** `/entitlements/aggregate/sources/{id}` | Aggregate entitlements [**list-entitlement-children**](#list-entitlement-children) | **Get** `/entitlements/{id}/children` | List of entitlements children [**list-entitlement-parents**](#list-entitlement-parents) | **Get** `/entitlements/{id}/parents` | List of entitlements parents [**list-entitlements**](#list-entitlements) | **Get** `/entitlements` | Gets a list of entitlements. [**patch-entitlement**](#patch-entitlement) | **Patch** `/entitlements/{id}` | Patch an entitlement -[**put-entitlement-request-config**](#put-entitlement-request-config) | **Put** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config -[**reset-source-entitlements**](#reset-source-entitlements) | **Post** `/entitlements/reset/sources/{id}` | Reset Source Entitlements +[**put-entitlement-request-config**](#put-entitlement-request-config) | **Put** `/entitlements/{id}/entitlement-request-config` | Replace entitlement request config +[**reset-source-entitlements**](#reset-source-entitlements) | **Post** `/entitlements/reset/sources/{id}` | Reset source entitlements [**update-entitlements-in-bulk**](#update-entitlements-in-bulk) | **Post** `/entitlements/bulk-update` | Bulk update an entitlement list @@ -338,7 +338,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Entitlement Request Config +Get entitlement request config This API returns the entitlement request config for a specified entitlement. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement-request-config) @@ -420,7 +420,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Aggregate Entitlements +Aggregate entitlements Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. @@ -863,7 +863,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Replace Entitlement Request Config +Replace entitlement request config This API replaces the entitlement request config for a specified entitlement. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-entitlement-request-config) @@ -971,7 +971,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Reset Source Entitlements +Reset source entitlements Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/GlobalTenantSecuritySettingsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/GlobalTenantSecuritySettingsAPI.md index 1dad0b043..446935531 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/GlobalTenantSecuritySettingsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/GlobalTenantSecuritySettingsAPI.md @@ -19,14 +19,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-auth-org-network-config**](#create-auth-org-network-config) | **Post** `/auth-org/network-config` | Create security network configuration. -[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **Get** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. +[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **Get** `/auth-org/lockout-config` | Get auth org lockout configuration. [**get-auth-org-network-config**](#get-auth-org-network-config) | **Get** `/auth-org/network-config` | Get security network configuration. -[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **Get** `/auth-org/service-provider-config` | Get Service Provider Configuration. -[**get-auth-org-session-config**](#get-auth-org-session-config) | **Get** `/auth-org/session-config` | Get Auth Org Session Configuration. -[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **Patch** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration +[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **Get** `/auth-org/service-provider-config` | Get service provider configuration. +[**get-auth-org-session-config**](#get-auth-org-session-config) | **Get** `/auth-org/session-config` | Get auth org session configuration. +[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **Patch** `/auth-org/lockout-config` | Update auth org lockout configuration [**patch-auth-org-network-config**](#patch-auth-org-network-config) | **Patch** `/auth-org/network-config` | Update security network configuration. -[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **Patch** `/auth-org/service-provider-config` | Update Service Provider Configuration -[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **Patch** `/auth-org/session-config` | Update Auth Org Session Configuration +[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **Patch** `/auth-org/service-provider-config` | Update service provider configuration +[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **Patch** `/auth-org/session-config` | Update auth org session configuration ## create-auth-org-network-config @@ -101,7 +101,7 @@ func main() { [[Back to top]](#) ## get-auth-org-lockout-config -Get Auth Org Lockout Configuration. +Get auth org lockout configuration. This API returns the details of an org's lockout auth configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-lockout-config) @@ -215,7 +215,7 @@ func main() { [[Back to top]](#) ## get-auth-org-service-provider-config -Get Service Provider Configuration. +Get service provider configuration. This API returns the details of an org's service provider auth configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-service-provider-config) @@ -272,7 +272,7 @@ func main() { [[Back to top]](#) ## get-auth-org-session-config -Get Auth Org Session Configuration. +Get auth org session configuration. This API returns the details of an org's session auth configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-session-config) @@ -329,7 +329,7 @@ func main() { [[Back to top]](#) ## patch-auth-org-lockout-config -Update Auth Org Lockout Configuration +Update auth org lockout configuration This API updates an existing lockout configuration for an org using PATCH @@ -465,7 +465,7 @@ func main() { [[Back to top]](#) ## patch-auth-org-service-provider-config -Update Service Provider Configuration +Update service provider configuration This API updates an existing service provider configuration for an org using PATCH. [API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-service-provider-config) @@ -532,7 +532,7 @@ func main() { [[Back to top]](#) ## patch-auth-org-session-config -Update Auth Org Session Configuration +Update auth org session configuration This API updates an existing session configuration for an org using PATCH. [API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-session-config) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/GovernanceGroupsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/GovernanceGroupsAPI.md index 117b2197e..33abe720b 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/GovernanceGroupsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/GovernanceGroupsAPI.md @@ -20,16 +20,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-workgroup**](#create-workgroup) | **Post** `/workgroups` | Create a new Governance Group. -[**delete-workgroup**](#delete-workgroup) | **Delete** `/workgroups/{id}` | Delete a Governance Group -[**delete-workgroup-members**](#delete-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group -[**delete-workgroups-in-bulk**](#delete-workgroups-in-bulk) | **Post** `/workgroups/bulk-delete` | Delete Governance Group(s) -[**get-workgroup**](#get-workgroup) | **Get** `/workgroups/{id}` | Get Governance Group by Id -[**list-connections**](#list-connections) | **Get** `/workgroups/{workgroupId}/connections` | List connections for Governance Group -[**list-workgroup-members**](#list-workgroup-members) | **Get** `/workgroups/{workgroupId}/members` | List Governance Group Members -[**list-workgroups**](#list-workgroups) | **Get** `/workgroups` | List Governance Groups -[**patch-workgroup**](#patch-workgroup) | **Patch** `/workgroups/{id}` | Patch a Governance Group -[**update-workgroup-members**](#update-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group +[**create-workgroup**](#create-workgroup) | **Post** `/workgroups` | Create a new governance group. +[**delete-workgroup**](#delete-workgroup) | **Delete** `/workgroups/{id}` | Delete a governance group +[**delete-workgroup-members**](#delete-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from governance group +[**delete-workgroups-in-bulk**](#delete-workgroups-in-bulk) | **Post** `/workgroups/bulk-delete` | Delete governance group(s) +[**get-workgroup**](#get-workgroup) | **Get** `/workgroups/{id}` | Get governance group by id +[**list-connections**](#list-connections) | **Get** `/workgroups/{workgroupId}/connections` | List connections for governance group +[**list-workgroup-members**](#list-workgroup-members) | **Get** `/workgroups/{workgroupId}/members` | List governance group members +[**list-workgroups**](#list-workgroups) | **Get** `/workgroups` | List governance groups +[**patch-workgroup**](#patch-workgroup) | **Patch** `/workgroups/{id}` | Patch a governance group +[**update-workgroup-members**](#update-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-add` | Add members to governance group ## create-workgroup @@ -44,7 +44,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create a new Governance Group. +Create a new governance group. This API creates a new Governance Group. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-workgroup) @@ -139,7 +139,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete a Governance Group +Delete a governance group This API deletes a Governance Group by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-workgroup) @@ -217,7 +217,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Remove members from Governance Group +Remove members from governance group This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** @@ -306,7 +306,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Governance Group(s) +Delete governance group(s) This API initiates a bulk deletion of one or more Governance Groups. @@ -399,7 +399,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Governance Group by Id +Get governance group by id This API returns a Governance Groups by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-workgroup) @@ -478,7 +478,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List connections for Governance Group +List connections for governance group This API returns list of connections associated with a Governance Group. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-connections) @@ -565,7 +565,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Governance Group Members +List governance group members This API returns list of members associated with a Governance Group. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-workgroup-members) @@ -652,7 +652,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Governance Groups +List governance groups This API returns list of Governance Groups [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-workgroups) @@ -735,7 +735,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch a Governance Group +Patch a governance group This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description @@ -819,7 +819,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Add members to Governance Group +Add members to governance group This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IAIAccessRequestRecommendationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IAIAccessRequestRecommendationsAPI.md index 1b07d70c5..6420fef6c 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/IAIAccessRequestRecommendationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IAIAccessRequestRecommendationsAPI.md @@ -15,16 +15,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **Post** `/ai-access-request-recommendations/ignored-items` | Ignore Access Request Recommendation -[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **Post** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation -[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **Post** `/ai-access-request-recommendations/viewed-items` | Mark Viewed Access Request Recommendations -[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **Post** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk Mark Viewed Access Request Recommendations -[**get-access-request-recommendations**](#get-access-request-recommendations) | **Get** `/ai-access-request-recommendations` | Identity Access Request Recommendations -[**get-access-request-recommendations-config**](#get-access-request-recommendations-config) | **Get** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config -[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **Get** `/ai-access-request-recommendations/ignored-items` | List Ignored Access Request Recommendations -[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **Get** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations -[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **Get** `/ai-access-request-recommendations/viewed-items` | List Viewed Access Request Recommendations -[**set-access-request-recommendations-config**](#set-access-request-recommendations-config) | **Put** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config +[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **Post** `/ai-access-request-recommendations/ignored-items` | Ignore access request recommendation +[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **Post** `/ai-access-request-recommendations/requested-items` | Accept access request recommendation +[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **Post** `/ai-access-request-recommendations/viewed-items` | Mark viewed access request recommendations +[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **Post** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk mark viewed access request recommendations +[**get-access-request-recommendations**](#get-access-request-recommendations) | **Get** `/ai-access-request-recommendations` | Identity access request recommendations +[**get-access-request-recommendations-config**](#get-access-request-recommendations-config) | **Get** `/ai-access-request-recommendations/config` | Get access request recommendations config +[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **Get** `/ai-access-request-recommendations/ignored-items` | List ignored access request recommendations +[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **Get** `/ai-access-request-recommendations/requested-items` | List accepted access request recommendations +[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **Get** `/ai-access-request-recommendations/viewed-items` | List viewed access request recommendations +[**set-access-request-recommendations-config**](#set-access-request-recommendations-config) | **Put** `/ai-access-request-recommendations/config` | Update access request recommendations config ## add-access-request-recommendations-ignored-item @@ -39,7 +39,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Ignore Access Request Recommendation +Ignore access request recommendation This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2025/add-access-request-recommendations-ignored-item) @@ -125,7 +125,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Accept Access Request Recommendation +Accept access request recommendation This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2025/add-access-request-recommendations-requested-item) @@ -211,7 +211,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Mark Viewed Access Request Recommendations +Mark viewed access request recommendations This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2025/add-access-request-recommendations-viewed-item) @@ -297,7 +297,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Bulk Mark Viewed Access Request Recommendations +Bulk mark viewed access request recommendations This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2025/add-access-request-recommendations-viewed-items) @@ -377,7 +377,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Identity Access Request Recommendations +Identity access request recommendations This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-recommendations) @@ -464,7 +464,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Access Request Recommendations config +Get access request recommendations config This API returns the configurations for Access Request Recommender for the tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-recommendations-config) @@ -537,7 +537,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Ignored Access Request Recommendations +List ignored access request recommendations This API returns the list of ignored access request recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-recommendations-ignored-items) @@ -620,7 +620,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Accepted Access Request Recommendations +List accepted access request recommendations This API returns a list of requested access request recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-recommendations-requested-items) @@ -703,7 +703,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Viewed Access Request Recommendations +List viewed access request recommendations This API returns the list of viewed access request recommendations. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-recommendations-viewed-items) @@ -786,7 +786,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Access Request Recommendations config +Update access request recommendations config This API updates the configurations for Access Request Recommender for the tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/set-access-request-recommendations-config) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IAIOutliersAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IAIOutliersAPI.md index 42ab928ab..263f3825c 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/IAIOutliersAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IAIOutliersAPI.md @@ -15,15 +15,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**export-outliers-zip**](#export-outliers-zip) | **Get** `/outliers/export` | IAI Identity Outliers Export -[**get-identity-outlier-snapshots**](#get-identity-outlier-snapshots) | **Get** `/outlier-summaries` | IAI Identity Outliers Summary -[**get-identity-outliers**](#get-identity-outliers) | **Get** `/outliers` | IAI Get Identity Outliers -[**get-latest-identity-outlier-snapshots**](#get-latest-identity-outlier-snapshots) | **Get** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary +[**export-outliers-zip**](#export-outliers-zip) | **Get** `/outliers/export` | Iai identity outliers export +[**get-identity-outlier-snapshots**](#get-identity-outlier-snapshots) | **Get** `/outlier-summaries` | Iai identity outliers summary +[**get-identity-outliers**](#get-identity-outliers) | **Get** `/outliers` | Iai get identity outliers +[**get-latest-identity-outlier-snapshots**](#get-latest-identity-outlier-snapshots) | **Get** `/outlier-summaries/latest` | Iai identity outliers latest summary [**get-outlier-contributing-feature-summary**](#get-outlier-contributing-feature-summary) | **Get** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary [**get-peer-group-outliers-contributing-features**](#get-peer-group-outliers-contributing-features) | **Get** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features -[**ignore-identity-outliers**](#ignore-identity-outliers) | **Post** `/outliers/ignore` | IAI Identity Outliers Ignore +[**ignore-identity-outliers**](#ignore-identity-outliers) | **Post** `/outliers/ignore` | Iai identity outliers ignore [**list-outliers-contributing-feature-access-items**](#list-outliers-contributing-feature-access-items) | **Get** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature -[**un-ignore-identity-outliers**](#un-ignore-identity-outliers) | **Post** `/outliers/unignore` | IAI Identity Outliers Unignore +[**un-ignore-identity-outliers**](#un-ignore-identity-outliers) | **Post** `/outliers/unignore` | Iai identity outliers unignore ## export-outliers-zip @@ -38,7 +38,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -IAI Identity Outliers Export +Iai identity outliers export This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). @@ -116,7 +116,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -IAI Identity Outliers Summary +Iai identity outliers summary This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-outlier-snapshots) @@ -199,7 +199,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -IAI Get Identity Outliers +Iai get identity outliers This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-outliers) @@ -284,7 +284,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -IAI Identity Outliers Latest Summary +Iai identity outliers latest summary This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-latest-identity-outlier-snapshots) @@ -533,7 +533,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -IAI Identity Outliers Ignore +Iai identity outliers ignore This API receives a list of identity IDs in the request, changes the outliers to be ignored. [API Spec](https://developer.sailpoint.com/docs/api/v2025/ignore-identity-outliers) @@ -707,7 +707,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -IAI Identity Outliers Unignore +Iai identity outliers unignore This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. [API Spec](https://developer.sailpoint.com/docs/api/v2025/un-ignore-identity-outliers) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IAIPeerGroupStrategiesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IAIPeerGroupStrategiesAPI.md index 5a6a7b7bb..9d662c8e7 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/IAIPeerGroupStrategiesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IAIPeerGroupStrategiesAPI.md @@ -15,7 +15,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-peer-group-outliers**](#get-peer-group-outliers) | **Get** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List +[**get-peer-group-outliers**](#get-peer-group-outliers) | **Get** `/peer-group-strategies/{strategy}/identity-outliers` | Identity outliers list ## get-peer-group-outliers @@ -33,7 +33,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Identity Outliers List +Identity outliers list -- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-peer-group-outliers) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IAIRecommendationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IAIRecommendationsAPI.md index 7228617cf..e41104938 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/IAIRecommendationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IAIRecommendationsAPI.md @@ -15,7 +15,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-recommendations**](#get-recommendations) | **Post** `/recommendations/request` | Returns Recommendation Based on Object +[**get-recommendations**](#get-recommendations) | **Post** `/recommendations/request` | Returns recommendation based on object [**get-recommendations-config**](#get-recommendations-config) | **Get** `/recommendations/config` | Get certification recommendation config values [**update-recommendations-config**](#update-recommendations-config) | **Put** `/recommendations/config` | Update certification recommendation config values @@ -32,7 +32,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Returns Recommendation Based on Object +Returns recommendation based on object The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-recommendations) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IdentitiesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IdentitiesAPI.md index 28a4fac0d..e07439c4c 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/IdentitiesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IdentitiesAPI.md @@ -31,15 +31,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**delete-identity**](#delete-identity) | **Delete** `/identities/{id}` | Delete identity -[**get-identity**](#get-identity) | **Get** `/identities/{id}` | Identity Details +[**get-identity**](#get-identity) | **Get** `/identities/{id}` | Identity details [**get-identity-ownership-details**](#get-identity-ownership-details) | **Get** `/identities/{identityId}/ownership` | Get ownership details [**get-role-assignment**](#get-role-assignment) | **Get** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details [**get-role-assignments**](#get-role-assignments) | **Get** `/identities/{identityId}/role-assignments` | List role assignments -[**list-identities**](#list-identities) | **Get** `/identities` | List Identities +[**list-identities**](#list-identities) | **Get** `/identities` | List identities [**reset-identity**](#reset-identity) | **Post** `/identities/{id}/reset` | Reset an identity [**send-identity-verification-account-token**](#send-identity-verification-account-token) | **Post** `/identities/{id}/verification/account/send` | Send password reset email [**start-identities-invite**](#start-identities-invite) | **Post** `/identities/invite` | Invite identities to register -[**start-identity-processing**](#start-identity-processing) | **Post** `/identities/process` | Process a list of identityIds +[**start-identity-processing**](#start-identity-processing) | **Post** `/identities/process` | Process a list of identityids [**synchronize-attributes-for-identity**](#synchronize-attributes-for-identity) | **Post** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. @@ -133,7 +133,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Identity Details +Identity details This API returns a single identity using the Identity ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity) @@ -458,7 +458,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Identities +List identities This API returns a list of identities. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-identities) @@ -798,7 +798,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Process a list of identityIds +Process a list of identityids This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. This endpoint will perform the following tasks: diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IdentityAttributesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IdentityAttributesAPI.md index 231104f01..9ed4637b4 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/IdentityAttributesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IdentityAttributesAPI.md @@ -15,12 +15,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-identity-attribute**](#create-identity-attribute) | **Post** `/identity-attributes` | Create Identity Attribute -[**delete-identity-attribute**](#delete-identity-attribute) | **Delete** `/identity-attributes/{name}` | Delete Identity Attribute -[**delete-identity-attributes-in-bulk**](#delete-identity-attributes-in-bulk) | **Delete** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes -[**get-identity-attribute**](#get-identity-attribute) | **Get** `/identity-attributes/{name}` | Get Identity Attribute -[**list-identity-attributes**](#list-identity-attributes) | **Get** `/identity-attributes` | List Identity Attributes -[**put-identity-attribute**](#put-identity-attribute) | **Put** `/identity-attributes/{name}` | Update Identity Attribute +[**create-identity-attribute**](#create-identity-attribute) | **Post** `/identity-attributes` | Create identity attribute +[**delete-identity-attribute**](#delete-identity-attribute) | **Delete** `/identity-attributes/{name}` | Delete identity attribute +[**delete-identity-attributes-in-bulk**](#delete-identity-attributes-in-bulk) | **Delete** `/identity-attributes/bulk-delete` | Bulk delete identity attributes +[**get-identity-attribute**](#get-identity-attribute) | **Get** `/identity-attributes/{name}` | Get identity attribute +[**list-identity-attributes**](#list-identity-attributes) | **Get** `/identity-attributes` | List identity attributes +[**put-identity-attribute**](#put-identity-attribute) | **Put** `/identity-attributes/{name}` | Update identity attribute ## create-identity-attribute @@ -35,7 +35,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create Identity Attribute +Create identity attribute Use this API to create a new identity attribute. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-identity-attribute) @@ -136,7 +136,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Identity Attribute +Delete identity attribute This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-identity-attribute) @@ -214,7 +214,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Bulk delete Identity Attributes +Bulk delete identity attributes Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-identity-attributes-in-bulk) @@ -295,7 +295,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Identity Attribute +Get identity attribute This gets an identity attribute for a given technical name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-attribute) @@ -374,7 +374,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Identity Attributes +List identity attributes Use this API to get a collection of identity attributes. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-identity-attributes) @@ -455,7 +455,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Identity Attribute +Update identity attribute This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-identity-attribute) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IdentityHistoryAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IdentityHistoryAPI.md index c4642f62e..33e8e1a13 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/IdentityHistoryAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IdentityHistoryAPI.md @@ -16,14 +16,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**compare-identity-snapshots**](#compare-identity-snapshots) | **Get** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots -[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **Get** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots +[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **Get** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accesstype for the given identity between 2 snapshots [**get-historical-identity**](#get-historical-identity) | **Get** `/historical-identities/{id}` | Get latest snapshot of identity [**get-historical-identity-events**](#get-historical-identity-events) | **Get** `/historical-identities/{id}/events` | Lists all events for the given identity [**get-identity-snapshot**](#get-identity-snapshot) | **Get** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date [**get-identity-snapshot-summary**](#get-identity-snapshot-summary) | **Get** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity [**get-identity-start-date**](#get-identity-start-date) | **Get** `/historical-identities/{id}/start-date` | Gets the start date of the identity [**list-historical-identities**](#list-historical-identities) | **Get** `/historical-identities` | Lists all the identities -[**list-identity-access-items**](#list-identity-access-items) | **Get** `/historical-identities/{id}/access-items` | List Access Items by Identity +[**list-identity-access-items**](#list-identity-access-items) | **Get** `/historical-identities/{id}/access-items` | List access items by identity [**list-identity-snapshot-access-items**](#list-identity-snapshot-access-items) | **Get** `/historical-identities/{id}/snapshots/{date}/access-items` | Gets the list of identity access items at a given date filterd by item type [**list-identity-snapshots**](#list-identity-snapshots) | **Get** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity @@ -131,7 +131,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Gets a list of differences of specific accessType for the given identity between 2 snapshots +Gets a list of differences of specific accesstype for the given identity between 2 snapshots This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' [API Spec](https://developer.sailpoint.com/docs/api/v2025/compare-identity-snapshots-access-type) @@ -730,7 +730,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Access Items by Identity +List access items by identity This method retrieves a list of access item for the identity filtered by the access item type diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IdentityProfilesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IdentityProfilesAPI.md index b8823a876..1170f148e 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/IdentityProfilesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IdentityProfilesAPI.md @@ -25,21 +25,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-identity-profile**](#create-identity-profile) | **Post** `/identity-profiles` | Create Identity Profile -[**delete-identity-profile**](#delete-identity-profile) | **Delete** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile -[**delete-identity-profiles**](#delete-identity-profiles) | **Post** `/identity-profiles/bulk-delete` | Delete Identity Profiles -[**export-identity-profiles**](#export-identity-profiles) | **Get** `/identity-profiles/export` | Export Identity Profiles -[**generate-identity-preview**](#generate-identity-preview) | **Post** `/identity-profiles/identity-preview` | Generate Identity Profile Preview -[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **Get** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config -[**get-identity-profile**](#get-identity-profile) | **Get** `/identity-profiles/{identity-profile-id}` | Get Identity Profile -[**import-identity-profiles**](#import-identity-profiles) | **Post** `/identity-profiles/import` | Import Identity Profiles -[**list-identity-profiles**](#list-identity-profiles) | **Get** `/identity-profiles` | List Identity Profiles +[**create-identity-profile**](#create-identity-profile) | **Post** `/identity-profiles` | Create identity profile +[**delete-identity-profile**](#delete-identity-profile) | **Delete** `/identity-profiles/{identity-profile-id}` | Delete identity profile +[**delete-identity-profiles**](#delete-identity-profiles) | **Post** `/identity-profiles/bulk-delete` | Delete identity profiles +[**export-identity-profiles**](#export-identity-profiles) | **Get** `/identity-profiles/export` | Export identity profiles +[**generate-identity-preview**](#generate-identity-preview) | **Post** `/identity-profiles/identity-preview` | Generate identity profile preview +[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **Get** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default identity attribute config +[**get-identity-profile**](#get-identity-profile) | **Get** `/identity-profiles/{identity-profile-id}` | Get identity profile +[**import-identity-profiles**](#import-identity-profiles) | **Post** `/identity-profiles/import` | Import identity profiles +[**list-identity-profiles**](#list-identity-profiles) | **Get** `/identity-profiles` | List identity profiles [**sync-identity-profile**](#sync-identity-profile) | **Post** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile -[**update-identity-profile**](#update-identity-profile) | **Patch** `/identity-profiles/{identity-profile-id}` | Update Identity Profile +[**update-identity-profile**](#update-identity-profile) | **Patch** `/identity-profiles/{identity-profile-id}` | Update identity profile ## create-identity-profile -Create Identity Profile +Create identity profile Creates an identity profile. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-identity-profile) @@ -154,7 +154,7 @@ func main() { [[Back to top]](#) ## delete-identity-profile -Delete Identity Profile +Delete identity profile Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. @@ -221,7 +221,7 @@ func main() { [[Back to top]](#) ## delete-identity-profiles -Delete Identity Profiles +Delete identity profiles This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. @@ -292,7 +292,7 @@ func main() { [[Back to top]](#) ## export-identity-profiles -Export Identity Profiles +Export identity profiles This exports existing identity profiles in the format specified by the sp-config service. [API Spec](https://developer.sailpoint.com/docs/api/v2025/export-identity-profiles) @@ -373,7 +373,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Generate Identity Profile Preview +Generate identity profile preview This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied. [API Spec](https://developer.sailpoint.com/docs/api/v2025/generate-identity-preview) @@ -468,7 +468,7 @@ func main() { [[Back to top]](#) ## get-default-identity-attribute-config -Get default Identity Attribute Config +Get default identity attribute config This returns the default identity attribute config. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-default-identity-attribute-config) @@ -534,7 +534,7 @@ func main() { [[Back to top]](#) ## get-identity-profile -Get Identity Profile +Get identity profile Get a single identity profile by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-profile) @@ -600,7 +600,7 @@ func main() { [[Back to top]](#) ## import-identity-profiles -Import Identity Profiles +Import identity profiles This imports previously exported identity profiles. [API Spec](https://developer.sailpoint.com/docs/api/v2025/import-identity-profiles) @@ -667,7 +667,7 @@ func main() { [[Back to top]](#) ## list-identity-profiles -List Identity Profiles +List identity profiles Get a list of identity profiles, based on the specified query parameters. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-identity-profiles) @@ -807,7 +807,7 @@ func main() { [[Back to top]](#) ## update-identity-profile -Update Identity Profile +Update identity profile Update a specified identity profile with this PATCH request. You cannot update these fields: diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/LifecycleStatesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/LifecycleStatesAPI.md index 22a80ec5e..ee570041f 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/LifecycleStatesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/LifecycleStatesAPI.md @@ -53,16 +53,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-lifecycle-state**](#create-lifecycle-state) | **Post** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State -[**delete-lifecycle-state**](#delete-lifecycle-state) | **Delete** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State -[**get-lifecycle-state**](#get-lifecycle-state) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State -[**get-lifecycle-states**](#get-lifecycle-states) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates -[**set-lifecycle-state**](#set-lifecycle-state) | **Post** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State -[**update-lifecycle-states**](#update-lifecycle-states) | **Patch** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State +[**create-lifecycle-state**](#create-lifecycle-state) | **Post** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create lifecycle state +[**delete-lifecycle-state**](#delete-lifecycle-state) | **Delete** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete lifecycle state +[**get-lifecycle-state**](#get-lifecycle-state) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get lifecycle state +[**get-lifecycle-states**](#get-lifecycle-states) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists lifecyclestates +[**set-lifecycle-state**](#set-lifecycle-state) | **Post** `/identities/{identity-id}/set-lifecycle-state` | Set lifecycle state +[**update-lifecycle-states**](#update-lifecycle-states) | **Patch** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update lifecycle state ## create-lifecycle-state -Create Lifecycle State +Create lifecycle state Use this endpoint to create a lifecycle state. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-lifecycle-state) @@ -159,7 +159,7 @@ func main() { [[Back to top]](#) ## delete-lifecycle-state -Delete Lifecycle State +Delete lifecycle state Use this endpoint to delete the lifecycle state by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-lifecycle-state) @@ -228,7 +228,7 @@ func main() { [[Back to top]](#) ## get-lifecycle-state -Get Lifecycle State +Get lifecycle state Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-lifecycle-state) @@ -297,7 +297,7 @@ func main() { [[Back to top]](#) ## get-lifecycle-states -Lists LifecycleStates +Lists lifecyclestates Use this endpoint to list all lifecycle states by their associated identity profiles. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-lifecycle-states) @@ -371,7 +371,7 @@ func main() { [[Back to top]](#) ## set-lifecycle-state -Set Lifecycle State +Set lifecycle state Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. [API Spec](https://developer.sailpoint.com/docs/api/v2025/set-lifecycle-state) @@ -444,7 +444,7 @@ func main() { [[Back to top]](#) ## update-lifecycle-states -Update Lifecycle State +Update lifecycle state Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. [API Spec](https://developer.sailpoint.com/docs/api/v2025/update-lifecycle-states) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/MFAConfigurationAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/MFAConfigurationAPI.md index e8e20ca72..8019acf16 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/MFAConfigurationAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/MFAConfigurationAPI.md @@ -15,17 +15,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-mfa-duo-config**](#get-mfa-duo-config) | **Get** `/mfa/duo-web/config` | Configuration of Duo MFA method -[**get-mfa-kba-config**](#get-mfa-kba-config) | **Get** `/mfa/kba/config` | Configuration of KBA MFA method -[**get-mfa-okta-config**](#get-mfa-okta-config) | **Get** `/mfa/okta-verify/config` | Configuration of Okta MFA method -[**set-mfa-duo-config**](#set-mfa-duo-config) | **Put** `/mfa/duo-web/config` | Set Duo MFA configuration -[**set-mfakba-config**](#set-mfakba-config) | **Post** `/mfa/kba/config/answers` | Set MFA KBA configuration -[**set-mfa-okta-config**](#set-mfa-okta-config) | **Put** `/mfa/okta-verify/config` | Set Okta MFA configuration -[**test-mfa-config**](#test-mfa-config) | **Get** `/mfa/{method}/test` | MFA method's test configuration +[**get-mfa-duo-config**](#get-mfa-duo-config) | **Get** `/mfa/duo-web/config` | Configuration of duo mfa method +[**get-mfa-kba-config**](#get-mfa-kba-config) | **Get** `/mfa/kba/config` | Configuration of kba mfa method +[**get-mfa-okta-config**](#get-mfa-okta-config) | **Get** `/mfa/okta-verify/config` | Configuration of okta mfa method +[**set-mfa-duo-config**](#set-mfa-duo-config) | **Put** `/mfa/duo-web/config` | Set duo mfa configuration +[**set-mfakba-config**](#set-mfakba-config) | **Post** `/mfa/kba/config/answers` | Set mfa kba configuration +[**set-mfa-okta-config**](#set-mfa-okta-config) | **Put** `/mfa/okta-verify/config` | Set okta mfa configuration +[**test-mfa-config**](#test-mfa-config) | **Get** `/mfa/{method}/test` | Mfa method's test configuration ## get-mfa-duo-config -Configuration of Duo MFA method +Configuration of duo mfa method This API returns the configuration of an Duo MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-mfa-duo-config) @@ -82,7 +82,7 @@ func main() { [[Back to top]](#) ## get-mfa-kba-config -Configuration of KBA MFA method +Configuration of kba mfa method This API returns the KBA configuration for MFA. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-mfa-kba-config) @@ -144,7 +144,7 @@ func main() { [[Back to top]](#) ## get-mfa-okta-config -Configuration of Okta MFA method +Configuration of okta mfa method This API returns the configuration of an Okta MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-mfa-okta-config) @@ -201,7 +201,7 @@ func main() { [[Back to top]](#) ## set-mfa-duo-config -Set Duo MFA configuration +Set duo mfa configuration This API sets the configuration of an Duo MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v2025/set-mfa-duo-config) @@ -278,7 +278,7 @@ func main() { [[Back to top]](#) ## set-mfakba-config -Set MFA KBA configuration +Set mfa kba configuration This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2025/set-mfakba-config) @@ -345,7 +345,7 @@ func main() { [[Back to top]](#) ## set-mfa-okta-config -Set Okta MFA configuration +Set okta mfa configuration This API sets the configuration of an Okta MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v2025/set-mfa-okta-config) @@ -418,7 +418,7 @@ func main() { [[Back to top]](#) ## test-mfa-config -MFA method's test configuration +Mfa method's test configuration This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. [API Spec](https://developer.sailpoint.com/docs/api/v2025/test-mfa-config) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/MachineAccountsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/MachineAccountsAPI.md index fa91f29dd..778bf7279 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/MachineAccountsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/MachineAccountsAPI.md @@ -15,9 +15,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-machine-account**](#get-machine-account) | **Get** `/machine-accounts/{id}` | Machine Account Details -[**list-machine-accounts**](#list-machine-accounts) | **Get** `/machine-accounts` | Machine Accounts List -[**update-machine-account**](#update-machine-account) | **Patch** `/machine-accounts/{id}` | Update a Machine Account +[**get-machine-account**](#get-machine-account) | **Get** `/machine-accounts/{id}` | Machine account details +[**list-machine-accounts**](#list-machine-accounts) | **Get** `/machine-accounts` | Machine accounts list +[**update-machine-account**](#update-machine-account) | **Patch** `/machine-accounts/{id}` | Update a machine account ## get-machine-account @@ -32,7 +32,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Machine Account Details +Machine account details Use this API to return the details for a single machine account by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-machine-account) @@ -111,7 +111,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Machine Accounts List +Machine accounts list This returns a list of machine accounts. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-machine-accounts) @@ -194,7 +194,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update a Machine Account +Update a machine account Use this API to update machine accounts details. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/MachineIdentitiesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/MachineIdentitiesAPI.md index 71d53232c..f1a0768b9 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/MachineIdentitiesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/MachineIdentitiesAPI.md @@ -15,11 +15,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-machine-identity**](#create-machine-identity) | **Post** `/machine-identities` | Create Machine Identities +[**create-machine-identity**](#create-machine-identity) | **Post** `/machine-identities` | Create machine identities [**delete-machine-identity**](#delete-machine-identity) | **Delete** `/machine-identities/{id}` | Delete machine identity -[**get-machine-identity**](#get-machine-identity) | **Get** `/machine-identities/{id}` | Machine Identity Details -[**list-machine-identities**](#list-machine-identities) | **Get** `/machine-identities` | List Machine Identities -[**update-machine-identity**](#update-machine-identity) | **Patch** `/machine-identities/{id}` | Update a Machine Identity +[**get-machine-identity**](#get-machine-identity) | **Get** `/machine-identities/{id}` | Machine identity details +[**list-machine-identities**](#list-machine-identities) | **Get** `/machine-identities` | List machine identities +[**update-machine-identity**](#update-machine-identity) | **Patch** `/machine-identities/{id}` | Update a machine identity ## create-machine-identity @@ -34,7 +34,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create Machine Identities +Create machine identities Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. @@ -202,7 +202,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Machine Identity Details +Machine identity details This API returns a single machine identity using the Machine Identity ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-machine-identity) @@ -281,7 +281,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Machine Identities +List machine identities This API returns a list of machine identities. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-machine-identities) @@ -364,7 +364,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update a Machine Identity +Update a machine identity Use this API to update machine identity details. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClientsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClientsAPI.md index 444364fd8..0087f79c6 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClientsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClientsAPI.md @@ -17,16 +17,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-managed-client**](#create-managed-client) | **Post** `/managed-clients` | Create Managed Client -[**delete-managed-client**](#delete-managed-client) | **Delete** `/managed-clients/{id}` | Delete Managed Client -[**get-managed-client**](#get-managed-client) | **Get** `/managed-clients/{id}` | Get Managed Client -[**get-managed-client-status**](#get-managed-client-status) | **Get** `/managed-clients/{id}/status` | Get Managed Client Status -[**get-managed-clients**](#get-managed-clients) | **Get** `/managed-clients` | Get Managed Clients -[**update-managed-client**](#update-managed-client) | **Patch** `/managed-clients/{id}` | Update Managed Client +[**create-managed-client**](#create-managed-client) | **Post** `/managed-clients` | Create managed client +[**delete-managed-client**](#delete-managed-client) | **Delete** `/managed-clients/{id}` | Delete managed client +[**get-managed-client**](#get-managed-client) | **Get** `/managed-clients/{id}` | Get managed client +[**get-managed-client-status**](#get-managed-client-status) | **Get** `/managed-clients/{id}/status` | Get managed client status +[**get-managed-clients**](#get-managed-clients) | **Get** `/managed-clients` | Get managed clients +[**update-managed-client**](#update-managed-client) | **Patch** `/managed-clients/{id}` | Update managed client ## create-managed-client -Create Managed Client +Create managed client Create a new managed client. The API returns a result that includes the managed client ID. @@ -99,7 +99,7 @@ func main() { [[Back to top]](#) ## delete-managed-client -Delete Managed Client +Delete managed client Delete an existing managed client. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-managed-client) @@ -164,7 +164,7 @@ func main() { [[Back to top]](#) ## get-managed-client -Get Managed Client +Get managed client Get managed client by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-client) @@ -230,7 +230,7 @@ func main() { [[Back to top]](#) ## get-managed-client-status -Get Managed Client Status +Get managed client status Get a managed client's status, using its ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-client-status) @@ -298,7 +298,7 @@ func main() { [[Back to top]](#) ## get-managed-clients -Get Managed Clients +Get managed clients List managed clients. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-clients) @@ -366,7 +366,7 @@ func main() { [[Back to top]](#) ## update-managed-client -Update Managed Client +Update managed client Update an existing managed client. [API Spec](https://developer.sailpoint.com/docs/api/v2025/update-managed-client) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClusterTypesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClusterTypesAPI.md index 2112da917..d249dceff 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClusterTypesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClusterTypesAPI.md @@ -17,15 +17,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-managed-cluster-type**](#create-managed-cluster-type) | **Post** `/managed-cluster-types` | Create new Managed Cluster Type -[**delete-managed-cluster-type**](#delete-managed-cluster-type) | **Delete** `/managed-cluster-types/{id}` | Delete a Managed Cluster Type -[**get-managed-cluster-type**](#get-managed-cluster-type) | **Get** `/managed-cluster-types/{id}` | Get a Managed Cluster Type -[**get-managed-cluster-types**](#get-managed-cluster-types) | **Get** `/managed-cluster-types` | List Managed Cluster Types -[**update-managed-cluster-type**](#update-managed-cluster-type) | **Patch** `/managed-cluster-types/{id}` | Update a Managed Cluster Type +[**create-managed-cluster-type**](#create-managed-cluster-type) | **Post** `/managed-cluster-types` | Create new managed cluster type +[**delete-managed-cluster-type**](#delete-managed-cluster-type) | **Delete** `/managed-cluster-types/{id}` | Delete a managed cluster type +[**get-managed-cluster-type**](#get-managed-cluster-type) | **Get** `/managed-cluster-types/{id}` | Get a managed cluster type +[**get-managed-cluster-types**](#get-managed-cluster-types) | **Get** `/managed-cluster-types` | List managed cluster types +[**update-managed-cluster-type**](#update-managed-cluster-type) | **Patch** `/managed-cluster-types/{id}` | Update a managed cluster type ## create-managed-cluster-type -Create new Managed Cluster Type +Create new managed cluster type Create a new Managed Cluster Type. The API returns a result that includes the Managed Cluster Type ID @@ -100,7 +100,7 @@ func main() { [[Back to top]](#) ## delete-managed-cluster-type -Delete a Managed Cluster Type +Delete a managed cluster type Delete an existing Managed Cluster Type. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-managed-cluster-type) @@ -165,7 +165,7 @@ func main() { [[Back to top]](#) ## get-managed-cluster-type -Get a Managed Cluster Type +Get a managed cluster type Get a Managed Cluster Type. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-cluster-type) @@ -231,7 +231,7 @@ func main() { [[Back to top]](#) ## get-managed-cluster-types -List Managed Cluster Types +List managed cluster types Get a list of Managed Cluster Types. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-cluster-types) @@ -301,7 +301,7 @@ func main() { [[Back to top]](#) ## update-managed-cluster-type -Update a Managed Cluster Type +Update a managed cluster type Update an existing Managed Cluster Type. [API Spec](https://developer.sailpoint.com/docs/api/v2025/update-managed-cluster-type) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClustersAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClustersAPI.md index 1bfd8451e..64db1d8f7 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClustersAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClustersAPI.md @@ -17,18 +17,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-managed-cluster**](#create-managed-cluster) | **Post** `/managed-clusters` | Create Create Managed Cluster -[**delete-managed-cluster**](#delete-managed-cluster) | **Delete** `/managed-clusters/{id}` | Delete Managed Cluster -[**get-client-log-configuration**](#get-client-log-configuration) | **Get** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration -[**get-managed-cluster**](#get-managed-cluster) | **Get** `/managed-clusters/{id}` | Get Managed Cluster -[**get-managed-clusters**](#get-managed-clusters) | **Get** `/managed-clusters` | Get Managed Clusters -[**put-client-log-configuration**](#put-client-log-configuration) | **Put** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration -[**update**](#update) | **Post** `/managed-clusters/{id}/manualUpgrade` | Trigger Manual Upgrade for Managed Cluster -[**update-managed-cluster**](#update-managed-cluster) | **Patch** `/managed-clusters/{id}` | Update Managed Cluster +[**create-managed-cluster**](#create-managed-cluster) | **Post** `/managed-clusters` | Create create managed cluster +[**delete-managed-cluster**](#delete-managed-cluster) | **Delete** `/managed-clusters/{id}` | Delete managed cluster +[**get-client-log-configuration**](#get-client-log-configuration) | **Get** `/managed-clusters/{id}/log-config` | Get managed cluster log configuration +[**get-managed-cluster**](#get-managed-cluster) | **Get** `/managed-clusters/{id}` | Get managed cluster +[**get-managed-clusters**](#get-managed-clusters) | **Get** `/managed-clusters` | Get managed clusters +[**put-client-log-configuration**](#put-client-log-configuration) | **Put** `/managed-clusters/{id}/log-config` | Update managed cluster log configuration +[**update**](#update) | **Post** `/managed-clusters/{id}/manualUpgrade` | Trigger manual upgrade for managed cluster +[**update-managed-cluster**](#update-managed-cluster) | **Patch** `/managed-clusters/{id}` | Update managed cluster ## create-managed-cluster -Create Create Managed Cluster +Create create managed cluster Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. @@ -104,7 +104,7 @@ func main() { [[Back to top]](#) ## delete-managed-cluster -Delete Managed Cluster +Delete managed cluster Delete an existing managed cluster. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-managed-cluster) @@ -171,7 +171,7 @@ func main() { [[Back to top]](#) ## get-client-log-configuration -Get Managed Cluster Log Configuration +Get managed cluster log configuration Get a managed cluster's log configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-client-log-configuration) @@ -237,7 +237,7 @@ func main() { [[Back to top]](#) ## get-managed-cluster -Get Managed Cluster +Get managed cluster Get a managed cluster by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-cluster) @@ -303,7 +303,7 @@ func main() { [[Back to top]](#) ## get-managed-clusters -Get Managed Clusters +Get managed clusters List current organization's managed clusters, based on request context. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-clusters) @@ -371,7 +371,7 @@ func main() { [[Back to top]](#) ## put-client-log-configuration -Update Managed Cluster Log Configuration +Update managed cluster log configuration Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-client-log-configuration) @@ -444,7 +444,7 @@ func main() { [[Back to top]](#) ## update -Trigger Manual Upgrade for Managed Cluster +Trigger manual upgrade for managed cluster Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. @@ -511,7 +511,7 @@ func main() { [[Back to top]](#) ## update-managed-cluster -Update Managed Cluster +Update managed cluster Update an existing managed cluster. [API Spec](https://developer.sailpoint.com/docs/api/v2025/update-managed-cluster) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/MultiHostIntegrationAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/MultiHostIntegrationAPI.md index 9b43ed3fd..0529298d5 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/MultiHostIntegrationAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/MultiHostIntegrationAPI.md @@ -18,23 +18,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-multi-host-integration**](#create-multi-host-integration) | **Post** `/multihosts` | Create Multi-Host Integration -[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **Post** `/multihosts/{multihostId}` | Create Sources Within Multi-Host Integration -[**delete-multi-host**](#delete-multi-host) | **Delete** `/multihosts/{multihostId}` | Delete Multi-Host Integration -[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **Get** `/multihosts/{multihostId}/acctAggregationGroups` | List Account-Aggregation-Groups by Multi-Host ID -[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **Get** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List Entitlement-Aggregation-Groups by Integration ID -[**get-multi-host-integrations**](#get-multi-host-integrations) | **Get** `/multihosts/{multihostId}` | Get Multi-Host Integration By ID -[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **Get** `/multihosts` | List All Existing Multi-Host Integrations -[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **Get** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors -[**get-multihost-integration-types**](#get-multihost-integration-types) | **Get** `/multihosts/types` | List Multi-Host Integration Types -[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **Get** `/multihosts/{multihostId}/sources` | List Sources Within Multi-Host Integration -[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **Post** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration -[**test-source-connection-multihost**](#test-source-connection-multihost) | **Get** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source -[**update-multi-host-sources**](#update-multi-host-sources) | **Patch** `/multihosts/{multihostId}` | Update Multi-Host Integration +[**create-multi-host-integration**](#create-multi-host-integration) | **Post** `/multihosts` | Create multi-host integration +[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **Post** `/multihosts/{multihostId}` | Create sources within multi-host integration +[**delete-multi-host**](#delete-multi-host) | **Delete** `/multihosts/{multihostId}` | Delete multi-host integration +[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **Get** `/multihosts/{multihostId}/acctAggregationGroups` | List account-aggregation-groups by multi-host id +[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **Get** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List entitlement-aggregation-groups by integration id +[**get-multi-host-integrations**](#get-multi-host-integrations) | **Get** `/multihosts/{multihostId}` | Get multi-host integration by id +[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **Get** `/multihosts` | List all existing multi-host integrations +[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **Get** `/multihosts/{multiHostId}/sources/errors` | List multi-host source creation errors +[**get-multihost-integration-types**](#get-multihost-integration-types) | **Get** `/multihosts/types` | List multi-host integration types +[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **Get** `/multihosts/{multihostId}/sources` | List sources within multi-host integration +[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **Post** `/multihosts/{multihostId}/sources/testConnection` | Test configuration for multi-host integration +[**test-source-connection-multihost**](#test-source-connection-multihost) | **Get** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test configuration for multi-host integration's single source +[**update-multi-host-sources**](#update-multi-host-sources) | **Patch** `/multihosts/{multihostId}` | Update multi-host integration ## create-multi-host-integration -Create Multi-Host Integration +Create multi-host integration This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -128,7 +128,7 @@ func main() { [[Back to top]](#) ## create-sources-within-multi-host -Create Sources Within Multi-Host Integration +Create sources within multi-host integration This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -202,7 +202,7 @@ func main() { [[Back to top]](#) ## delete-multi-host -Delete Multi-Host Integration +Delete multi-host integration Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. @@ -269,7 +269,7 @@ func main() { [[Back to top]](#) ## get-acct-aggregation-groups -List Account-Aggregation-Groups by Multi-Host ID +List account-aggregation-groups by multi-host id This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -340,7 +340,7 @@ func main() { [[Back to top]](#) ## get-entitlement-aggregation-groups -List Entitlement-Aggregation-Groups by Integration ID +List entitlement-aggregation-groups by integration id This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -412,7 +412,7 @@ func main() { [[Back to top]](#) ## get-multi-host-integrations -Get Multi-Host Integration By ID +Get multi-host integration by id Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. @@ -480,7 +480,7 @@ func main() { [[Back to top]](#) ## get-multi-host-integrations-list -List All Existing Multi-Host Integrations +List all existing multi-host integrations Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -554,7 +554,7 @@ func main() { [[Back to top]](#) ## get-multi-host-source-creation-errors -List Multi-Host Source Creation Errors +List multi-host source creation errors Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -622,7 +622,7 @@ func main() { [[Back to top]](#) ## get-multihost-integration-types -List Multi-Host Integration Types +List multi-host integration types This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -681,7 +681,7 @@ func main() { [[Back to top]](#) ## get-sources-within-multi-host -List Sources Within Multi-Host Integration +List sources within multi-host integration Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -759,7 +759,7 @@ func main() { [[Back to top]](#) ## test-connection-multi-host-sources -Test Configuration For Multi-Host Integration +Test configuration for multi-host integration This endpoint performs a more detailed validation of the Multi-Host Integration's configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -826,7 +826,7 @@ func main() { [[Back to top]](#) ## test-source-connection-multihost -Test Configuration For Multi-Host Integration's Single Source +Test configuration for multi-host integration's single source This endpoint performs a more detailed validation of the source's configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. @@ -897,7 +897,7 @@ func main() { [[Back to top]](#) ## update-multi-host-sources -Update Multi-Host Integration +Update multi-host integration Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/NonEmployeeLifecycleManagementAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/NonEmployeeLifecycleManagementAPI.md index 8a31806c4..dbae7ba39 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/NonEmployeeLifecycleManagementAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/NonEmployeeLifecycleManagementAPI.md @@ -46,42 +46,42 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-non-employee-request**](#approve-non-employee-request) | **Post** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request -[**create-non-employee-record**](#create-non-employee-record) | **Post** `/non-employee-records` | Create Non-Employee Record -[**create-non-employee-request**](#create-non-employee-request) | **Post** `/non-employee-requests` | Create Non-Employee Request -[**create-non-employee-source**](#create-non-employee-source) | **Post** `/non-employee-sources` | Create Non-Employee Source -[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **Post** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source -[**delete-non-employee-record**](#delete-non-employee-record) | **Delete** `/non-employee-records/{id}` | Delete Non-Employee Record -[**delete-non-employee-records-in-bulk**](#delete-non-employee-records-in-bulk) | **Post** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records -[**delete-non-employee-request**](#delete-non-employee-request) | **Delete** `/non-employee-requests/{id}` | Delete Non-Employee Request -[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source -[**delete-non-employee-source**](#delete-non-employee-source) | **Delete** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source -[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source -[**export-non-employee-records**](#export-non-employee-records) | **Get** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV -[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **Get** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**approve-non-employee-request**](#approve-non-employee-request) | **Post** `/non-employee-approvals/{id}/approve` | Approve a non-employee request +[**create-non-employee-record**](#create-non-employee-record) | **Post** `/non-employee-records` | Create non-employee record +[**create-non-employee-request**](#create-non-employee-request) | **Post** `/non-employee-requests` | Create non-employee request +[**create-non-employee-source**](#create-non-employee-source) | **Post** `/non-employee-sources` | Create non-employee source +[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **Post** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new schema attribute for non-employee source +[**delete-non-employee-record**](#delete-non-employee-record) | **Delete** `/non-employee-records/{id}` | Delete non-employee record +[**delete-non-employee-records-in-bulk**](#delete-non-employee-records-in-bulk) | **Post** `/non-employee-records/bulk-delete` | Delete multiple non-employee records +[**delete-non-employee-request**](#delete-non-employee-request) | **Delete** `/non-employee-requests/{id}` | Delete non-employee request +[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a schema attribute for non-employee source +[**delete-non-employee-source**](#delete-non-employee-source) | **Delete** `/non-employee-sources/{sourceId}` | Delete non-employee source +[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for non-employee source +[**export-non-employee-records**](#export-non-employee-records) | **Get** `/non-employee-sources/{id}/non-employees/download` | Exports non-employee records to csv +[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **Get** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports source schema template [**get-non-employee-approval**](#get-non-employee-approval) | **Get** `/non-employee-approvals/{id}` | Get a non-employee approval item detail -[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **Get** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests +[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **Get** `/non-employee-approvals/summary/{requested-for}` | Get summary of non-employee approval requests [**get-non-employee-bulk-upload-status**](#get-non-employee-bulk-upload-status) | **Get** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source -[**get-non-employee-record**](#get-non-employee-record) | **Get** `/non-employee-records/{id}` | Get a Non-Employee Record -[**get-non-employee-request**](#get-non-employee-request) | **Get** `/non-employee-requests/{id}` | Get a Non-Employee Request -[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **Get** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests -[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **Get** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source -[**get-non-employee-source**](#get-non-employee-source) | **Get** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source -[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **Get** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source -[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **Post** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records -[**list-non-employee-approvals**](#list-non-employee-approvals) | **Get** `/non-employee-approvals` | Get List of Non-Employee Approval Requests -[**list-non-employee-records**](#list-non-employee-records) | **Get** `/non-employee-records` | List Non-Employee Records -[**list-non-employee-requests**](#list-non-employee-requests) | **Get** `/non-employee-requests` | List Non-Employee Requests -[**list-non-employee-sources**](#list-non-employee-sources) | **Get** `/non-employee-sources` | List Non-Employee Sources -[**patch-non-employee-record**](#patch-non-employee-record) | **Patch** `/non-employee-records/{id}` | Patch Non-Employee Record -[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **Patch** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source -[**patch-non-employee-source**](#patch-non-employee-source) | **Patch** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source -[**reject-non-employee-request**](#reject-non-employee-request) | **Post** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request -[**update-non-employee-record**](#update-non-employee-record) | **Put** `/non-employee-records/{id}` | Update Non-Employee Record +[**get-non-employee-record**](#get-non-employee-record) | **Get** `/non-employee-records/{id}` | Get a non-employee record +[**get-non-employee-request**](#get-non-employee-request) | **Get** `/non-employee-requests/{id}` | Get a non-employee request +[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **Get** `/non-employee-requests/summary/{requested-for}` | Get summary of non-employee requests +[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **Get** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get schema attribute non-employee source +[**get-non-employee-source**](#get-non-employee-source) | **Get** `/non-employee-sources/{sourceId}` | Get a non-employee source +[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **Get** `/non-employee-sources/{sourceId}/schema-attributes` | List schema attributes non-employee source +[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **Post** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or updates, non-employee records +[**list-non-employee-approvals**](#list-non-employee-approvals) | **Get** `/non-employee-approvals` | Get list of non-employee approval requests +[**list-non-employee-records**](#list-non-employee-records) | **Get** `/non-employee-records` | List non-employee records +[**list-non-employee-requests**](#list-non-employee-requests) | **Get** `/non-employee-requests` | List non-employee requests +[**list-non-employee-sources**](#list-non-employee-sources) | **Get** `/non-employee-sources` | List non-employee sources +[**patch-non-employee-record**](#patch-non-employee-record) | **Patch** `/non-employee-records/{id}` | Patch non-employee record +[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **Patch** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a schema attribute for non-employee source +[**patch-non-employee-source**](#patch-non-employee-source) | **Patch** `/non-employee-sources/{sourceId}` | Patch a non-employee source +[**reject-non-employee-request**](#reject-non-employee-request) | **Post** `/non-employee-approvals/{id}/reject` | Reject a non-employee request +[**update-non-employee-record**](#update-non-employee-record) | **Put** `/non-employee-records/{id}` | Update non-employee record ## approve-non-employee-request -Approve a Non-Employee Request +Approve a non-employee request Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. [API Spec](https://developer.sailpoint.com/docs/api/v2025/approve-non-employee-request) @@ -156,7 +156,7 @@ func main() { [[Back to top]](#) ## create-non-employee-record -Create Non-Employee Record +Create non-employee record This request will create a non-employee record. Requires role context of `idn:nesr:create` @@ -238,7 +238,7 @@ func main() { [[Back to top]](#) ## create-non-employee-request -Create Non-Employee Request +Create non-employee request This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-non-employee-request) @@ -319,7 +319,7 @@ func main() { [[Back to top]](#) ## create-non-employee-source -Create Non-Employee Source +Create non-employee source Create a non-employee source. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-non-employee-source) @@ -411,7 +411,7 @@ func main() { [[Back to top]](#) ## create-non-employee-source-schema-attributes -Create a new Schema Attribute for Non-Employee Source +Create a new schema attribute for non-employee source This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. Requires role context of `idn:nesr:create` @@ -492,7 +492,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-record -Delete Non-Employee Record +Delete non-employee record This request will delete a non-employee record. Requires role context of `idn:nesr:delete` @@ -558,7 +558,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-records-in-bulk -Delete Multiple Non-Employee Records +Delete multiple non-employee records This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-non-employee-records-in-bulk) @@ -624,7 +624,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-request -Delete Non-Employee Request +Delete non-employee request This request will delete a non-employee request. Requires role context of `idn:nesr:delete` @@ -690,7 +690,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-schema-attribute -Delete a Schema Attribute for Non-Employee Source +Delete a schema attribute for non-employee source This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` @@ -760,7 +760,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-source -Delete Non-Employee Source +Delete non-employee source This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-non-employee-source) @@ -825,7 +825,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-source-schema-attributes -Delete all custom schema attributes for Non-Employee Source +Delete all custom schema attributes for non-employee source This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-non-employee-source-schema-attributes) @@ -890,7 +890,7 @@ func main() { [[Back to top]](#) ## export-non-employee-records -Exports Non-Employee Records to CSV +Exports non-employee records to csv This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` [API Spec](https://developer.sailpoint.com/docs/api/v2025/export-non-employee-records) @@ -955,7 +955,7 @@ func main() { [[Back to top]](#) ## export-non-employee-source-schema-template -Exports Source Schema Template +Exports source schema template This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` [API Spec](https://developer.sailpoint.com/docs/api/v2025/export-non-employee-source-schema-template) @@ -1091,7 +1091,7 @@ func main() { [[Back to top]](#) ## get-non-employee-approval-summary -Get Summary of Non-Employee Approval Requests +Get summary of non-employee approval requests This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. @@ -1229,7 +1229,7 @@ func main() { [[Back to top]](#) ## get-non-employee-record -Get a Non-Employee Record +Get a non-employee record This gets a non-employee record. Requires role context of `idn:nesr:read` @@ -1296,7 +1296,7 @@ func main() { [[Back to top]](#) ## get-non-employee-request -Get a Non-Employee Request +Get a non-employee request This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user @@ -1366,7 +1366,7 @@ func main() { [[Back to top]](#) ## get-non-employee-request-summary -Get Summary of Non-Employee Requests +Get summary of non-employee requests This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. @@ -1436,7 +1436,7 @@ func main() { [[Back to top]](#) ## get-non-employee-schema-attribute -Get Schema Attribute Non-Employee Source +Get schema attribute non-employee source This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-non-employee-schema-attribute) @@ -1505,7 +1505,7 @@ func main() { [[Back to top]](#) ## get-non-employee-source -Get a Non-Employee Source +Get a non-employee source This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. @@ -1575,7 +1575,7 @@ func main() { [[Back to top]](#) ## get-non-employee-source-schema-attributes -List Schema Attributes Non-Employee Source +List schema attributes non-employee source This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. @@ -1642,7 +1642,7 @@ func main() { [[Back to top]](#) ## import-non-employee-records-in-bulk -Imports, or Updates, Non-Employee Records +Imports, or updates, non-employee records This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` [API Spec](https://developer.sailpoint.com/docs/api/v2025/import-non-employee-records-in-bulk) @@ -1710,7 +1710,7 @@ func main() { [[Back to top]](#) ## list-non-employee-approvals -Get List of Non-Employee Approval Requests +Get list of non-employee approval requests This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they @@ -1786,7 +1786,7 @@ func main() { [[Back to top]](#) ## list-non-employee-records -List Non-Employee Records +List non-employee records This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. @@ -1858,7 +1858,7 @@ func main() { [[Back to top]](#) ## list-non-employee-requests -List Non-Employee Requests +List non-employee requests This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. @@ -1934,7 +1934,7 @@ func main() { [[Back to top]](#) ## list-non-employee-sources -List Non-Employee Sources +List non-employee sources Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. @@ -2008,7 +2008,7 @@ func main() { [[Back to top]](#) ## patch-non-employee-record -Patch Non-Employee Record +Patch non-employee record This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. @@ -2085,7 +2085,7 @@ func main() { [[Back to top]](#) ## patch-non-employee-schema-attribute -Patch a Schema Attribute for Non-Employee Source +Patch a schema attribute for non-employee source This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` @@ -2163,7 +2163,7 @@ func main() { [[Back to top]](#) ## patch-non-employee-source -Patch a Non-Employee Source +Patch a non-employee source patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. [API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-non-employee-source) @@ -2236,7 +2236,7 @@ func main() { [[Back to top]](#) ## reject-non-employee-request -Reject a Non-Employee Request +Reject a non-employee request This endpoint will reject an approval item request and notify user. The current user must be the requested approver. [API Spec](https://developer.sailpoint.com/docs/api/v2025/reject-non-employee-request) @@ -2311,7 +2311,7 @@ func main() { [[Back to top]](#) ## update-non-employee-record -Update Non-Employee Record +Update non-employee record This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/NotificationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/NotificationsAPI.md index 7e2025cb3..4a0d79da0 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/NotificationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/NotificationsAPI.md @@ -15,21 +15,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-domain-dkim**](#create-domain-dkim) | **Post** `/verified-domains` | Verify domain address via DKIM -[**create-notification-template**](#create-notification-template) | **Post** `/notification-templates` | Create Notification Template -[**create-verified-from-address**](#create-verified-from-address) | **Post** `/verified-from-addresses` | Create Verified From Address -[**delete-notification-templates-in-bulk**](#delete-notification-templates-in-bulk) | **Post** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates -[**delete-verified-from-address**](#delete-verified-from-address) | **Delete** `/verified-from-addresses/{id}` | Delete Verified From Address -[**get-dkim-attributes**](#get-dkim-attributes) | **Get** `/verified-domains` | Get DKIM Attributes -[**get-mail-from-attributes**](#get-mail-from-attributes) | **Get** `/mail-from-attributes/{identity}` | Get MAIL FROM Attributes -[**get-notification-template**](#get-notification-template) | **Get** `/notification-templates/{id}` | Get Notification Template By Id -[**get-notifications-template-context**](#get-notifications-template-context) | **Get** `/notification-template-context` | Get Notification Template Context -[**list-from-addresses**](#list-from-addresses) | **Get** `/verified-from-addresses` | List From Addresses -[**list-notification-preferences**](#list-notification-preferences) | **Get** `/notification-preferences/{key}` | List Notification Preferences for tenant. -[**list-notification-template-defaults**](#list-notification-template-defaults) | **Get** `/notification-template-defaults` | List Notification Template Defaults -[**list-notification-templates**](#list-notification-templates) | **Get** `/notification-templates` | List Notification Templates -[**put-mail-from-attributes**](#put-mail-from-attributes) | **Put** `/mail-from-attributes` | Change MAIL FROM domain -[**send-test-notification**](#send-test-notification) | **Post** `/send-test-notification` | Send Test Notification +[**create-domain-dkim**](#create-domain-dkim) | **Post** `/verified-domains` | Verify domain address via dkim +[**create-notification-template**](#create-notification-template) | **Post** `/notification-templates` | Create notification template +[**create-verified-from-address**](#create-verified-from-address) | **Post** `/verified-from-addresses` | Create verified from address +[**delete-notification-templates-in-bulk**](#delete-notification-templates-in-bulk) | **Post** `/notification-templates/bulk-delete` | Bulk delete notification templates +[**delete-verified-from-address**](#delete-verified-from-address) | **Delete** `/verified-from-addresses/{id}` | Delete verified from address +[**get-dkim-attributes**](#get-dkim-attributes) | **Get** `/verified-domains` | Get dkim attributes +[**get-mail-from-attributes**](#get-mail-from-attributes) | **Get** `/mail-from-attributes/{identity}` | Get mail from attributes +[**get-notification-template**](#get-notification-template) | **Get** `/notification-templates/{id}` | Get notification template by id +[**get-notifications-template-context**](#get-notifications-template-context) | **Get** `/notification-template-context` | Get notification template context +[**list-from-addresses**](#list-from-addresses) | **Get** `/verified-from-addresses` | List from addresses +[**list-notification-preferences**](#list-notification-preferences) | **Get** `/notification-preferences/{key}` | List notification preferences for tenant. +[**list-notification-template-defaults**](#list-notification-template-defaults) | **Get** `/notification-template-defaults` | List notification template defaults +[**list-notification-templates**](#list-notification-templates) | **Get** `/notification-templates` | List notification templates +[**put-mail-from-attributes**](#put-mail-from-attributes) | **Put** `/mail-from-attributes` | Change mail from domain +[**send-test-notification**](#send-test-notification) | **Post** `/send-test-notification` | Send test notification ## create-domain-dkim @@ -44,7 +44,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Verify domain address via DKIM +Verify domain address via dkim Create a domain to be verified via DKIM (DomainKeys Identified Mail) [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-domain-dkim) @@ -126,7 +126,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create Notification Template +Create notification template This creates a template for your site. You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. @@ -225,7 +225,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create Verified From Address +Create verified from address Create a new sender email address and initiate verification process. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-verified-from-address) @@ -310,7 +310,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Bulk Delete Notification Templates +Bulk delete notification templates This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-notification-templates-in-bulk) @@ -389,7 +389,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Verified From Address +Delete verified from address Delete a verified sender email address [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-verified-from-address) @@ -467,7 +467,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get DKIM Attributes +Get dkim attributes Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-dkim-attributes) @@ -540,7 +540,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get MAIL FROM Attributes +Get mail from attributes Retrieve MAIL FROM attributes for a given AWS SES identity. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-mail-from-attributes) @@ -615,7 +615,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Notification Template By Id +Get notification template by id This gets a template that you have modified for your site by Id. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-notification-template) @@ -694,7 +694,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Notification Template Context +Get notification template context The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). @@ -768,7 +768,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List From Addresses +List from addresses Retrieve a list of sender email addresses and their verification statuses [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-from-addresses) @@ -851,7 +851,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Notification Preferences for tenant. +List notification preferences for tenant. Returns a list of notification preferences for tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-notification-preferences) @@ -924,7 +924,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Notification Template Defaults +List notification template defaults This lists the default templates used for notifications, such as emails from IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-notification-template-defaults) @@ -1003,7 +1003,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Notification Templates +List notification templates This lists the templates that you have modified for your site. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-notification-templates) @@ -1082,7 +1082,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Change MAIL FROM domain +Change mail from domain Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-mail-from-attributes) @@ -1165,7 +1165,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Send Test Notification +Send test notification Send a Test Notification [API Spec](https://developer.sailpoint.com/docs/api/v2025/send-test-notification) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/OAuthClientsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/OAuthClientsAPI.md index 834b75cf1..1a135f358 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/OAuthClientsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/OAuthClientsAPI.md @@ -18,15 +18,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-oauth-client**](#create-oauth-client) | **Post** `/oauth-clients` | Create OAuth Client -[**delete-oauth-client**](#delete-oauth-client) | **Delete** `/oauth-clients/{id}` | Delete OAuth Client -[**get-oauth-client**](#get-oauth-client) | **Get** `/oauth-clients/{id}` | Get OAuth Client -[**list-oauth-clients**](#list-oauth-clients) | **Get** `/oauth-clients` | List OAuth Clients -[**patch-oauth-client**](#patch-oauth-client) | **Patch** `/oauth-clients/{id}` | Patch OAuth Client +[**create-oauth-client**](#create-oauth-client) | **Post** `/oauth-clients` | Create oauth client +[**delete-oauth-client**](#delete-oauth-client) | **Delete** `/oauth-clients/{id}` | Delete oauth client +[**get-oauth-client**](#get-oauth-client) | **Get** `/oauth-clients/{id}` | Get oauth client +[**list-oauth-clients**](#list-oauth-clients) | **Get** `/oauth-clients` | List oauth clients +[**patch-oauth-client**](#patch-oauth-client) | **Patch** `/oauth-clients/{id}` | Patch oauth client ## create-oauth-client -Create OAuth Client +Create oauth client This creates an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-oauth-client) @@ -109,7 +109,7 @@ func main() { [[Back to top]](#) ## delete-oauth-client -Delete OAuth Client +Delete oauth client This deletes an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-oauth-client) @@ -174,7 +174,7 @@ func main() { [[Back to top]](#) ## get-oauth-client -Get OAuth Client +Get oauth client This gets details of an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-oauth-client) @@ -240,7 +240,7 @@ func main() { [[Back to top]](#) ## list-oauth-clients -List OAuth Clients +List oauth clients This gets a list of OAuth clients. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-oauth-clients) @@ -302,7 +302,7 @@ func main() { [[Back to top]](#) ## patch-oauth-client -Patch OAuth Client +Patch oauth client This performs a targeted update to the field(s) of an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-oauth-client) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/OrgConfigAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/OrgConfigAPI.md index cdeec0640..5061b7dcd 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/OrgConfigAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/OrgConfigAPI.md @@ -17,9 +17,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-org-config**](#get-org-config) | **Get** `/org-config` | Get Org Config Settings -[**get-valid-time-zones**](#get-valid-time-zones) | **Get** `/org-config/valid-time-zones` | Get Valid Time Zones -[**patch-org-config**](#patch-org-config) | **Patch** `/org-config` | Patch Org Config +[**get-org-config**](#get-org-config) | **Get** `/org-config` | Get org config settings +[**get-valid-time-zones**](#get-valid-time-zones) | **Get** `/org-config/valid-time-zones` | Get valid time zones +[**patch-org-config**](#patch-org-config) | **Patch** `/org-config` | Patch org config ## get-org-config @@ -34,7 +34,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Org Config Settings +Get org config settings Get the current organization's configuration settings, only external accessible properties. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-org-config) @@ -107,7 +107,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Valid Time Zones +Get valid time zones List the valid time zones that can be set in organization configurations. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-valid-time-zones) @@ -186,7 +186,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch Org Config +Patch org config Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone. [API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-org-config) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordConfigurationAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordConfigurationAPI.md index ec406308a..50a7f88a8 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordConfigurationAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordConfigurationAPI.md @@ -21,13 +21,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-password-org-config**](#create-password-org-config) | **Post** `/password-org-config` | Create Password Org Config -[**get-password-org-config**](#get-password-org-config) | **Get** `/password-org-config` | Get Password Org Config -[**put-password-org-config**](#put-password-org-config) | **Put** `/password-org-config` | Update Password Org Config +[**create-password-org-config**](#create-password-org-config) | **Post** `/password-org-config` | Create password org config +[**get-password-org-config**](#get-password-org-config) | **Get** `/password-org-config` | Get password org config +[**put-password-org-config**](#put-password-org-config) | **Put** `/password-org-config` | Update password org config ## create-password-org-config -Create Password Org Config +Create password org config This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' @@ -101,7 +101,7 @@ func main() { [[Back to top]](#) ## get-password-org-config -Get Password Org Config +Get password org config This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-password-org-config) @@ -158,7 +158,7 @@ func main() { [[Back to top]](#) ## put-password-org-config -Update Password Org Config +Update password org config This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordDictionaryAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordDictionaryAPI.md index 744c3babc..8167e65e8 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordDictionaryAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordDictionaryAPI.md @@ -62,12 +62,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-password-dictionary**](#get-password-dictionary) | **Get** `/password-dictionary` | Get Password Dictionary -[**put-password-dictionary**](#put-password-dictionary) | **Put** `/password-dictionary` | Update Password Dictionary +[**get-password-dictionary**](#get-password-dictionary) | **Get** `/password-dictionary` | Get password dictionary +[**put-password-dictionary**](#put-password-dictionary) | **Put** `/password-dictionary` | Update password dictionary ## get-password-dictionary -Get Password Dictionary +Get password dictionary This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing @@ -152,7 +152,7 @@ func main() { [[Back to top]](#) ## put-password-dictionary -Update Password Dictionary +Update password dictionary This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordManagementAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordManagementAPI.md index 8dec0757b..053dcd2bd 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordManagementAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordManagementAPI.md @@ -40,9 +40,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-digit-token**](#create-digit-token) | **Post** `/generate-password-reset-token/digit` | Generate a digit token -[**get-password-change-status**](#get-password-change-status) | **Get** `/password-change-status/{id}` | Get Password Change Request Status -[**query-password-info**](#query-password-info) | **Post** `/query-password-info` | Query Password Info -[**set-password**](#set-password) | **Post** `/set-password` | Set Identity's Password +[**get-password-change-status**](#get-password-change-status) | **Get** `/password-change-status/{id}` | Get password change request status +[**query-password-info**](#query-password-info) | **Post** `/query-password-info` | Query password info +[**set-password**](#set-password) | **Post** `/set-password` | Set identity's password ## create-digit-token @@ -130,7 +130,7 @@ func main() { [[Back to top]](#) ## get-password-change-status -Get Password Change Request Status +Get password change request status This API returns the status of a password change request. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-password-change-status) @@ -196,7 +196,7 @@ func main() { [[Back to top]](#) ## query-password-info -Query Password Info +Query password info This API is used to query password related information. @@ -267,7 +267,7 @@ func main() { [[Back to top]](#) ## set-password -Set Identity's Password +Set identity's password This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordPoliciesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordPoliciesAPI.md index 94d22a19d..2ef2e8508 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordPoliciesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordPoliciesAPI.md @@ -23,15 +23,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-password-policy**](#create-password-policy) | **Post** `/password-policies` | Create Password Policy -[**delete-password-policy**](#delete-password-policy) | **Delete** `/password-policies/{id}` | Delete Password Policy by ID -[**get-password-policy-by-id**](#get-password-policy-by-id) | **Get** `/password-policies/{id}` | Get Password Policy by ID -[**list-password-policies**](#list-password-policies) | **Get** `/password-policies` | List Password Policies -[**set-password-policy**](#set-password-policy) | **Put** `/password-policies/{id}` | Update Password Policy by ID +[**create-password-policy**](#create-password-policy) | **Post** `/password-policies` | Create password policy +[**delete-password-policy**](#delete-password-policy) | **Delete** `/password-policies/{id}` | Delete password policy by id +[**get-password-policy-by-id**](#get-password-policy-by-id) | **Get** `/password-policies/{id}` | Get password policy by id +[**list-password-policies**](#list-password-policies) | **Get** `/password-policies` | List password policies +[**set-password-policy**](#set-password-policy) | **Put** `/password-policies/{id}` | Update password policy by id ## create-password-policy -Create Password Policy +Create password policy This API creates the specified password policy. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-password-policy) @@ -130,7 +130,7 @@ func main() { [[Back to top]](#) ## delete-password-policy -Delete Password Policy by ID +Delete password policy by id This API deletes the specified password policy. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-password-policy) @@ -195,7 +195,7 @@ func main() { [[Back to top]](#) ## get-password-policy-by-id -Get Password Policy by ID +Get password policy by id This API returns the password policy for the specified ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-password-policy-by-id) @@ -261,7 +261,7 @@ func main() { [[Back to top]](#) ## list-password-policies -List Password Policies +List password policies This gets list of all Password Policies. Requires role of ORG_ADMIN @@ -328,7 +328,7 @@ func main() { [[Back to top]](#) ## set-password-policy -Update Password Policy by ID +Update password policy by id This API updates the specified password policy. [API Spec](https://developer.sailpoint.com/docs/api/v2025/set-password-policy) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordSyncGroupsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordSyncGroupsAPI.md index 128934790..71cf64952 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordSyncGroupsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordSyncGroupsAPI.md @@ -47,15 +47,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-password-sync-group**](#create-password-sync-group) | **Post** `/password-sync-groups` | Create Password Sync Group -[**delete-password-sync-group**](#delete-password-sync-group) | **Delete** `/password-sync-groups/{id}` | Delete Password Sync Group by ID -[**get-password-sync-group**](#get-password-sync-group) | **Get** `/password-sync-groups/{id}` | Get Password Sync Group by ID -[**get-password-sync-groups**](#get-password-sync-groups) | **Get** `/password-sync-groups` | Get Password Sync Group List -[**update-password-sync-group**](#update-password-sync-group) | **Put** `/password-sync-groups/{id}` | Update Password Sync Group by ID +[**create-password-sync-group**](#create-password-sync-group) | **Post** `/password-sync-groups` | Create password sync group +[**delete-password-sync-group**](#delete-password-sync-group) | **Delete** `/password-sync-groups/{id}` | Delete password sync group by id +[**get-password-sync-group**](#get-password-sync-group) | **Get** `/password-sync-groups/{id}` | Get password sync group by id +[**get-password-sync-groups**](#get-password-sync-groups) | **Get** `/password-sync-groups` | Get password sync group list +[**update-password-sync-group**](#update-password-sync-group) | **Put** `/password-sync-groups/{id}` | Update password sync group by id ## create-password-sync-group -Create Password Sync Group +Create password sync group This API creates a password sync group based on the specifications provided. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-password-sync-group) @@ -129,7 +129,7 @@ func main() { [[Back to top]](#) ## delete-password-sync-group -Delete Password Sync Group by ID +Delete password sync group by id This API deletes the specified password sync group. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-password-sync-group) @@ -194,7 +194,7 @@ func main() { [[Back to top]](#) ## get-password-sync-group -Get Password Sync Group by ID +Get password sync group by id This API returns the sync group for the specified ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-password-sync-group) @@ -260,7 +260,7 @@ func main() { [[Back to top]](#) ## get-password-sync-groups -Get Password Sync Group List +Get password sync group list This API returns a list of password sync groups. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-password-sync-groups) @@ -326,7 +326,7 @@ func main() { [[Back to top]](#) ## update-password-sync-group -Update Password Sync Group by ID +Update password sync group by id This API updates the specified password sync group. [API Spec](https://developer.sailpoint.com/docs/api/v2025/update-password-sync-group) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PersonalAccessTokensAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PersonalAccessTokensAPI.md index dd289e2ad..059e7250a 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/PersonalAccessTokensAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PersonalAccessTokensAPI.md @@ -26,14 +26,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-personal-access-token**](#create-personal-access-token) | **Post** `/personal-access-tokens` | Create Personal Access Token -[**delete-personal-access-token**](#delete-personal-access-token) | **Delete** `/personal-access-tokens/{id}` | Delete Personal Access Token -[**list-personal-access-tokens**](#list-personal-access-tokens) | **Get** `/personal-access-tokens` | List Personal Access Tokens -[**patch-personal-access-token**](#patch-personal-access-token) | **Patch** `/personal-access-tokens/{id}` | Patch Personal Access Token +[**create-personal-access-token**](#create-personal-access-token) | **Post** `/personal-access-tokens` | Create personal access token +[**delete-personal-access-token**](#delete-personal-access-token) | **Delete** `/personal-access-tokens/{id}` | Delete personal access token +[**list-personal-access-tokens**](#list-personal-access-tokens) | **Get** `/personal-access-tokens` | List personal access tokens +[**patch-personal-access-token**](#patch-personal-access-token) | **Patch** `/personal-access-tokens/{id}` | Patch personal access token ## create-personal-access-token -Create Personal Access Token +Create personal access token This creates a personal access token. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-personal-access-token) @@ -104,7 +104,7 @@ func main() { [[Back to top]](#) ## delete-personal-access-token -Delete Personal Access Token +Delete personal access token This deletes a personal access token. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-personal-access-token) @@ -169,7 +169,7 @@ func main() { [[Back to top]](#) ## list-personal-access-tokens -List Personal Access Tokens +List personal access tokens This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-personal-access-tokens) @@ -233,7 +233,7 @@ func main() { [[Back to top]](#) ## patch-personal-access-token -Patch Personal Access Token +Patch personal access token This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PublicIdentitiesConfigAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PublicIdentitiesConfigAPI.md index 6cedd9775..ae11c1696 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/PublicIdentitiesConfigAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PublicIdentitiesConfigAPI.md @@ -25,12 +25,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-public-identity-config**](#get-public-identity-config) | **Get** `/public-identities-config` | Get the Public Identities Configuration -[**update-public-identity-config**](#update-public-identity-config) | **Put** `/public-identities-config` | Update the Public Identities Configuration +[**get-public-identity-config**](#get-public-identity-config) | **Get** `/public-identities-config` | Get the public identities configuration +[**update-public-identity-config**](#update-public-identity-config) | **Put** `/public-identities-config` | Update the public identities configuration ## get-public-identity-config -Get the Public Identities Configuration +Get the public identities configuration Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-public-identity-config) @@ -87,7 +87,7 @@ func main() { [[Back to top]](#) ## update-public-identity-config -Update the Public Identities Configuration +Update the public identities configuration Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. [API Spec](https://developer.sailpoint.com/docs/api/v2025/update-public-identity-config) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ReportsDataExtractionAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ReportsDataExtractionAPI.md index be3574137..4dbb110e8 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/ReportsDataExtractionAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ReportsDataExtractionAPI.md @@ -18,14 +18,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**cancel-report**](#cancel-report) | **Post** `/reports/{id}/cancel` | Cancel Report -[**get-report**](#get-report) | **Get** `/reports/{taskResultId}` | Get Report File -[**get-report-result**](#get-report-result) | **Get** `/reports/{taskResultId}/result` | Get Report Result -[**start-report**](#start-report) | **Post** `/reports/run` | Run Report +[**cancel-report**](#cancel-report) | **Post** `/reports/{id}/cancel` | Cancel report +[**get-report**](#get-report) | **Get** `/reports/{taskResultId}` | Get report file +[**get-report-result**](#get-report-result) | **Get** `/reports/{taskResultId}/result` | Get report result +[**start-report**](#start-report) | **Post** `/reports/run` | Run report ## cancel-report -Cancel Report +Cancel report Cancels a running report. [API Spec](https://developer.sailpoint.com/docs/api/v2025/cancel-report) @@ -90,7 +90,7 @@ func main() { [[Back to top]](#) ## get-report -Get Report File +Get report file Gets a report in file format. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-report) @@ -162,7 +162,7 @@ func main() { [[Back to top]](#) ## get-report-result -Get Report Result +Get report result Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-report-result) @@ -230,7 +230,7 @@ func main() { [[Back to top]](#) ## start-report -Run Report +Run report Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. [API Spec](https://developer.sailpoint.com/docs/api/v2025/start-report) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/RequestableObjectsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/RequestableObjectsAPI.md index d17bcb80c..f97b55c41 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/RequestableObjectsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/RequestableObjectsAPI.md @@ -18,11 +18,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**list-requestable-objects**](#list-requestable-objects) | **Get** `/requestable-objects` | Requestable Objects List +[**list-requestable-objects**](#list-requestable-objects) | **Get** `/requestable-objects` | Requestable objects list ## list-requestable-objects -Requestable Objects List +Requestable objects list Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/RolesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/RolesAPI.md index 27602a551..22814334d 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/RolesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/RolesAPI.md @@ -52,26 +52,26 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-role**](#create-role) | **Post** `/roles` | Create a Role -[**delete-bulk-roles**](#delete-bulk-roles) | **Post** `/roles/bulk-delete` | Delete Role(s) -[**delete-metadata-from-role-by-key-and-value**](#delete-metadata-from-role-by-key-and-value) | **Delete** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a Metadata From Role. -[**delete-role**](#delete-role) | **Delete** `/roles/{id}` | Delete a Role -[**get-bulk-update-status**](#get-bulk-update-status) | **Get** `/roles/access-model-metadata/bulk-update` | Get Bulk-Update Statuses -[**get-bulk-update-status-by-id**](#get-bulk-update-status-by-id) | **Get** `/roles/access-model-metadata/bulk-update/id` | Get Bulk-Update Status by ID -[**get-role**](#get-role) | **Get** `/roles/{id}` | Get a Role -[**get-role-assigned-identities**](#get-role-assigned-identities) | **Get** `/roles/{id}/assigned-identities` | List Identities assigned a Role -[**get-role-entitlements**](#get-role-entitlements) | **Get** `/roles/{id}/entitlements` | List Role's Entitlements -[**list-roles**](#list-roles) | **Get** `/roles` | List Roles -[**patch-role**](#patch-role) | **Patch** `/roles/{id}` | Patch a specified Role -[**search-roles-by-filter**](#search-roles-by-filter) | **Post** `/roles/filter` | Filter Roles by Metadata -[**update-attribute-key-and-value-to-role**](#update-attribute-key-and-value-to-role) | **Post** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a Metadata to Role. -[**update-roles-metadata-by-filter**](#update-roles-metadata-by-filter) | **Post** `/roles/access-model-metadata/bulk-update/filter` | Bulk-Update Roles' Metadata by Filters -[**update-roles-metadata-by-ids**](#update-roles-metadata-by-ids) | **Post** `/roles/access-model-metadata/bulk-update/ids` | Bulk-Update Roles' Metadata by ID -[**update-roles-metadata-by-query**](#update-roles-metadata-by-query) | **Post** `/roles/access-model-metadata/bulk-update/query` | Bulk-Update Roles' Metadata by Query +[**create-role**](#create-role) | **Post** `/roles` | Create a role +[**delete-bulk-roles**](#delete-bulk-roles) | **Post** `/roles/bulk-delete` | Delete role(s) +[**delete-metadata-from-role-by-key-and-value**](#delete-metadata-from-role-by-key-and-value) | **Delete** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a metadata from role. +[**delete-role**](#delete-role) | **Delete** `/roles/{id}` | Delete a role +[**get-bulk-update-status**](#get-bulk-update-status) | **Get** `/roles/access-model-metadata/bulk-update` | Get bulk-update statuses +[**get-bulk-update-status-by-id**](#get-bulk-update-status-by-id) | **Get** `/roles/access-model-metadata/bulk-update/id` | Get bulk-update status by id +[**get-role**](#get-role) | **Get** `/roles/{id}` | Get a role +[**get-role-assigned-identities**](#get-role-assigned-identities) | **Get** `/roles/{id}/assigned-identities` | List identities assigned a role +[**get-role-entitlements**](#get-role-entitlements) | **Get** `/roles/{id}/entitlements` | List role's entitlements +[**list-roles**](#list-roles) | **Get** `/roles` | List roles +[**patch-role**](#patch-role) | **Patch** `/roles/{id}` | Patch a specified role +[**search-roles-by-filter**](#search-roles-by-filter) | **Post** `/roles/filter` | Filter roles by metadata +[**update-attribute-key-and-value-to-role**](#update-attribute-key-and-value-to-role) | **Post** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a metadata to role. +[**update-roles-metadata-by-filter**](#update-roles-metadata-by-filter) | **Post** `/roles/access-model-metadata/bulk-update/filter` | Bulk-update roles' metadata by filters +[**update-roles-metadata-by-ids**](#update-roles-metadata-by-ids) | **Post** `/roles/access-model-metadata/bulk-update/ids` | Bulk-update roles' metadata by id +[**update-roles-metadata-by-query**](#update-roles-metadata-by-query) | **Post** `/roles/access-model-metadata/bulk-update/query` | Bulk-update roles' metadata by query ## create-role -Create a Role +Create a role This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. @@ -302,7 +302,7 @@ func main() { [[Back to top]](#) ## delete-bulk-roles -Delete Role(s) +Delete role(s) This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. @@ -374,7 +374,7 @@ func main() { [[Back to top]](#) ## delete-metadata-from-role-by-key-and-value -Remove a Metadata From Role. +Remove a metadata from role. This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-metadata-from-role-by-key-and-value) @@ -445,7 +445,7 @@ func main() { [[Back to top]](#) ## delete-role -Delete a Role +Delete a role This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. @@ -512,7 +512,7 @@ func main() { [[Back to top]](#) ## get-bulk-update-status -Get Bulk-Update Statuses +Get bulk-update statuses This API returns a list of all unfinished bulk update process status of the tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-bulk-update-status) @@ -569,7 +569,7 @@ func main() { [[Back to top]](#) ## get-bulk-update-status-by-id -Get Bulk-Update Status by ID +Get bulk-update status by id This API initial a request for one bulk update's status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. @@ -637,7 +637,7 @@ func main() { [[Back to top]](#) ## get-role -Get a Role +Get a role This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. @@ -704,7 +704,7 @@ func main() { [[Back to top]](#) ## get-role-assigned-identities -List Identities assigned a Role +List identities assigned a role [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-assigned-identities) @@ -791,7 +791,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Role's Entitlements +List role's entitlements Get a list of entitlements associated with a specified role. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-entitlements) @@ -869,7 +869,7 @@ func main() { [[Back to top]](#) ## list-roles -List Roles +List roles This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. @@ -947,7 +947,7 @@ func main() { [[Back to top]](#) ## patch-role -Patch a specified Role +Patch a specified role This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: @@ -1040,7 +1040,7 @@ func main() { [[Back to top]](#) ## search-roles-by-filter -Filter Roles by Metadata +Filter roles by metadata This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. @@ -1123,7 +1123,7 @@ func main() { [[Back to top]](#) ## update-attribute-key-and-value-to-role -Add a Metadata to Role. +Add a metadata to role. This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. [API Spec](https://developer.sailpoint.com/docs/api/v2025/update-attribute-key-and-value-to-role) @@ -1195,7 +1195,7 @@ func main() { [[Back to top]](#) ## update-roles-metadata-by-filter -Bulk-Update Roles' Metadata by Filters +Bulk-update roles' metadata by filters This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. @@ -1273,7 +1273,7 @@ func main() { [[Back to top]](#) ## update-roles-metadata-by-ids -Bulk-Update Roles' Metadata by ID +Bulk-update roles' metadata by id This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. @@ -1351,7 +1351,7 @@ func main() { [[Back to top]](#) ## update-roles-metadata-by-query -Bulk-Update Roles' Metadata by Query +Bulk-update roles' metadata by query This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SIMIntegrationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SIMIntegrationsAPI.md index e3ed87bc2..f1e61df84 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/SIMIntegrationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SIMIntegrationsAPI.md @@ -22,13 +22,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-sim-integration**](#create-sim-integration) | **Post** `/sim-integrations` | Create new SIM integration -[**delete-sim-integration**](#delete-sim-integration) | **Delete** `/sim-integrations/{id}` | Delete a SIM integration -[**get-sim-integration**](#get-sim-integration) | **Get** `/sim-integrations/{id}` | Get a SIM integration details. -[**get-sim-integrations**](#get-sim-integrations) | **Get** `/sim-integrations` | List the existing SIM integrations. -[**patch-before-provisioning-rule**](#patch-before-provisioning-rule) | **Patch** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute. -[**patch-sim-attributes**](#patch-sim-attributes) | **Patch** `/sim-integrations/{id}` | Patch a SIM attribute. -[**put-sim-integration**](#put-sim-integration) | **Put** `/sim-integrations/{id}` | Update an existing SIM integration +[**create-sim-integration**](#create-sim-integration) | **Post** `/sim-integrations` | Create new sim integration +[**delete-sim-integration**](#delete-sim-integration) | **Delete** `/sim-integrations/{id}` | Delete a sim integration +[**get-sim-integration**](#get-sim-integration) | **Get** `/sim-integrations/{id}` | Get a sim integration details. +[**get-sim-integrations**](#get-sim-integrations) | **Get** `/sim-integrations` | List the existing sim integrations. +[**patch-before-provisioning-rule**](#patch-before-provisioning-rule) | **Patch** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a sim beforeprovisioningrule attribute. +[**patch-sim-attributes**](#patch-sim-attributes) | **Patch** `/sim-integrations/{id}` | Patch a sim attribute. +[**put-sim-integration**](#put-sim-integration) | **Put** `/sim-integrations/{id}` | Update an existing sim integration ## create-sim-integration @@ -43,7 +43,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create new SIM integration +Create new sim integration Create a new SIM Integrations. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-sim-integration) @@ -140,7 +140,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete a SIM integration +Delete a sim integration Get the details of a SIM integration. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-sim-integration) @@ -218,7 +218,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get a SIM integration details. +Get a sim integration details. Get the details of a SIM integration. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sim-integration) @@ -297,7 +297,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List the existing SIM integrations. +List the existing sim integrations. List the existing SIM integrations. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sim-integrations) @@ -370,7 +370,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch a SIM beforeProvisioningRule attribute. +Patch a sim beforeprovisioningrule attribute. Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. [API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-before-provisioning-rule) @@ -466,7 +466,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch a SIM attribute. +Patch a sim attribute. Patch a SIM attribute given a JsonPatch object. [API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-sim-attributes) @@ -562,7 +562,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update an existing SIM integration +Update an existing sim integration Update an existing SIM integration. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-sim-integration) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SODPoliciesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SODPoliciesAPI.md index aa1d95077..20931fe6a 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/SODPoliciesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SODPoliciesAPI.md @@ -41,27 +41,27 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-sod-policy**](#create-sod-policy) | **Post** `/sod-policies` | Create SOD policy -[**delete-sod-policy**](#delete-sod-policy) | **Delete** `/sod-policies/{id}` | Delete SOD policy by ID -[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **Delete** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**create-sod-policy**](#create-sod-policy) | **Post** `/sod-policies` | Create sod policy +[**delete-sod-policy**](#delete-sod-policy) | **Delete** `/sod-policies/{id}` | Delete sod policy by id +[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **Delete** `/sod-policies/{id}/schedule` | Delete sod policy schedule [**get-custom-violation-report**](#get-custom-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report [**get-default-violation-report**](#get-default-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download` | Download violation report [**get-sod-all-report-run-status**](#get-sod-all-report-run-status) | **Get** `/sod-violation-report` | Get multi-report run task status -[**get-sod-policy**](#get-sod-policy) | **Get** `/sod-policies/{id}` | Get SOD policy by ID -[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **Get** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**get-sod-policy**](#get-sod-policy) | **Get** `/sod-policies/{id}` | Get sod policy by id +[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **Get** `/sod-policies/{id}/schedule` | Get sod policy schedule [**get-sod-violation-report-run-status**](#get-sod-violation-report-run-status) | **Get** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status -[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **Get** `/sod-policies/{id}/violation-report` | Get SOD violation report status -[**list-sod-policies**](#list-sod-policies) | **Get** `/sod-policies` | List SOD policies -[**patch-sod-policy**](#patch-sod-policy) | **Patch** `/sod-policies/{id}` | Patch SOD policy by ID -[**put-policy-schedule**](#put-policy-schedule) | **Put** `/sod-policies/{id}/schedule` | Update SOD Policy schedule -[**put-sod-policy**](#put-sod-policy) | **Put** `/sod-policies/{id}` | Update SOD policy by ID -[**start-evaluate-sod-policy**](#start-evaluate-sod-policy) | **Post** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID +[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **Get** `/sod-policies/{id}/violation-report` | Get sod violation report status +[**list-sod-policies**](#list-sod-policies) | **Get** `/sod-policies` | List sod policies +[**patch-sod-policy**](#patch-sod-policy) | **Patch** `/sod-policies/{id}` | Patch sod policy by id +[**put-policy-schedule**](#put-policy-schedule) | **Put** `/sod-policies/{id}/schedule` | Update sod policy schedule +[**put-sod-policy**](#put-sod-policy) | **Put** `/sod-policies/{id}` | Update sod policy by id +[**start-evaluate-sod-policy**](#start-evaluate-sod-policy) | **Post** `/sod-policies/{id}/evaluate` | Evaluate one policy by id [**start-sod-all-policies-for-org**](#start-sod-all-policies-for-org) | **Post** `/sod-violation-report/run` | Runs all policies for org -[**start-sod-policy**](#start-sod-policy) | **Post** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report +[**start-sod-policy**](#start-sod-policy) | **Post** `/sod-policies/{id}/violation-report/run` | Runs sod policy violation report ## create-sod-policy -Create SOD policy +Create sod policy This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. @@ -184,7 +184,7 @@ func main() { [[Back to top]](#) ## delete-sod-policy -Delete SOD policy by ID +Delete sod policy by id This deletes a specified SOD policy. Requires role of ORG_ADMIN. @@ -252,7 +252,7 @@ func main() { [[Back to top]](#) ## delete-sod-policy-schedule -Delete SOD policy schedule +Delete sod policy schedule This deletes schedule for a specified SOD policy by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-sod-policy-schedule) @@ -509,7 +509,7 @@ func main() { [[Back to top]](#) ## get-sod-policy -Get SOD policy by ID +Get sod policy by id This gets specified SOD policy. Requires role of ORG_ADMIN. @@ -576,7 +576,7 @@ func main() { [[Back to top]](#) ## get-sod-policy-schedule -Get SOD policy schedule +Get sod policy schedule This endpoint gets a specified SOD policy's schedule. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sod-policy-schedule) @@ -708,7 +708,7 @@ func main() { [[Back to top]](#) ## get-sod-violation-report-status -Get SOD violation report status +Get sod violation report status This gets the status for a violation report run task that has already been invoked. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sod-violation-report-status) @@ -774,7 +774,7 @@ func main() { [[Back to top]](#) ## list-sod-policies -List SOD policies +List sod policies This gets list of all SOD policies. Requires role of ORG_ADMIN @@ -845,7 +845,7 @@ func main() { [[Back to top]](#) ## patch-sod-policy -Patch SOD policy by ID +Patch sod policy by id Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. @@ -920,7 +920,7 @@ func main() { [[Back to top]](#) ## put-policy-schedule -Update SOD Policy schedule +Update sod policy schedule This updates schedule for a specified SOD policy. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-policy-schedule) @@ -1078,7 +1078,7 @@ func main() { [[Back to top]](#) ## put-sod-policy -Update SOD policy by ID +Update sod policy by id This updates a specified SOD policy. Requires role of ORG_ADMIN. @@ -1207,7 +1207,7 @@ func main() { [[Back to top]](#) ## start-evaluate-sod-policy -Evaluate one policy by ID +Evaluate one policy by id Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/start-evaluate-sod-policy) @@ -1337,7 +1337,7 @@ func main() { [[Back to top]](#) ## start-sod-policy -Runs SOD policy violation report +Runs sod policy violation report This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. [API Spec](https://developer.sailpoint.com/docs/api/v2025/start-sod-policy) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SODViolationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SODViolationsAPI.md index 9eb6026ed..ff10d5fdd 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/SODViolationsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SODViolationsAPI.md @@ -33,12 +33,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**start-predict-sod-violations**](#start-predict-sod-violations) | **Post** `/sod-violations/predict` | Predict SOD violations for identity. -[**start-violation-check**](#start-violation-check) | **Post** `/sod-violations/check` | Check SOD violations +[**start-predict-sod-violations**](#start-predict-sod-violations) | **Post** `/sod-violations/predict` | Predict sod violations for identity. +[**start-violation-check**](#start-violation-check) | **Post** `/sod-violations/check` | Check sod violations ## start-predict-sod-violations -Predict SOD violations for identity. +Predict sod violations for identity. This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. [API Spec](https://developer.sailpoint.com/docs/api/v2025/start-predict-sod-violations) @@ -116,7 +116,7 @@ func main() { [[Back to top]](#) ## start-violation-check -Check SOD violations +Check sod violations This API initiates a SOD policy verification asynchronously. [API Spec](https://developer.sailpoint.com/docs/api/v2025/start-violation-check) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SPConfigAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SPConfigAPI.md index 7825e749f..fef7f2d61 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/SPConfigAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SPConfigAPI.md @@ -21,7 +21,7 @@ Method | HTTP request | Description [**get-sp-config-import**](#get-sp-config-import) | **Get** `/sp-config/import/{id}/download` | Download import job result [**get-sp-config-import-status**](#get-sp-config-import-status) | **Get** `/sp-config/import/{id}` | Get import job status [**import-sp-config**](#import-sp-config) | **Post** `/sp-config/import` | Initiates configuration objects import job -[**list-sp-config-objects**](#list-sp-config-objects) | **Get** `/sp-config/config-objects` | List Config Objects +[**list-sp-config-objects**](#list-sp-config-objects) | **Get** `/sp-config/config-objects` | List config objects ## export-sp-config @@ -445,7 +445,7 @@ func main() { [[Back to top]](#) ## list-sp-config-objects -List Config Objects +List config objects Get a list of object configurations that the tenant export/import service knows. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-sp-config-objects) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SavedSearchAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SavedSearchAPI.md index a1d9e8f98..a3160a015 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/SavedSearchAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SavedSearchAPI.md @@ -26,10 +26,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-saved-search**](#create-saved-search) | **Post** `/saved-searches` | Create a saved search -[**delete-saved-search**](#delete-saved-search) | **Delete** `/saved-searches/{id}` | Delete document by ID -[**execute-saved-search**](#execute-saved-search) | **Post** `/saved-searches/{id}/execute` | Execute a saved search by ID -[**get-saved-search**](#get-saved-search) | **Get** `/saved-searches/{id}` | Return saved search by ID -[**list-saved-searches**](#list-saved-searches) | **Get** `/saved-searches` | A list of Saved Searches +[**delete-saved-search**](#delete-saved-search) | **Delete** `/saved-searches/{id}` | Delete document by id +[**execute-saved-search**](#execute-saved-search) | **Post** `/saved-searches/{id}/execute` | Execute a saved search by id +[**get-saved-search**](#get-saved-search) | **Get** `/saved-searches/{id}` | Return saved search by id +[**list-saved-searches**](#list-saved-searches) | **Get** `/saved-searches` | A list of saved searches [**put-saved-search**](#put-saved-search) | **Put** `/saved-searches/{id}` | Updates an existing saved search @@ -102,7 +102,7 @@ func main() { [[Back to top]](#) ## delete-saved-search -Delete document by ID +Delete document by id Deletes the specified saved search. @@ -168,7 +168,7 @@ func main() { [[Back to top]](#) ## execute-saved-search -Execute a saved search by ID +Execute a saved search by id Executes the specified saved search. @@ -251,7 +251,7 @@ func main() { [[Back to top]](#) ## get-saved-search -Return saved search by ID +Return saved search by id Returns the specified saved search. @@ -318,7 +318,7 @@ func main() { [[Back to top]](#) ## list-saved-searches -A list of Saved Searches +A list of saved searches Returns a list of saved searches. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ScheduledSearchAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ScheduledSearchAPI.md index e07d58464..1b45df92f 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/ScheduledSearchAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ScheduledSearchAPI.md @@ -42,11 +42,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-scheduled-search**](#create-scheduled-search) | **Post** `/scheduled-searches` | Create a new scheduled search -[**delete-scheduled-search**](#delete-scheduled-search) | **Delete** `/scheduled-searches/{id}` | Delete a Scheduled Search -[**get-scheduled-search**](#get-scheduled-search) | **Get** `/scheduled-searches/{id}` | Get a Scheduled Search +[**delete-scheduled-search**](#delete-scheduled-search) | **Delete** `/scheduled-searches/{id}` | Delete a scheduled search +[**get-scheduled-search**](#get-scheduled-search) | **Get** `/scheduled-searches/{id}` | Get a scheduled search [**list-scheduled-search**](#list-scheduled-search) | **Get** `/scheduled-searches` | List scheduled searches -[**unsubscribe-scheduled-search**](#unsubscribe-scheduled-search) | **Post** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search -[**update-scheduled-search**](#update-scheduled-search) | **Put** `/scheduled-searches/{id}` | Update an existing Scheduled Search +[**unsubscribe-scheduled-search**](#unsubscribe-scheduled-search) | **Post** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from scheduled search +[**update-scheduled-search**](#update-scheduled-search) | **Put** `/scheduled-searches/{id}` | Update an existing scheduled search ## create-scheduled-search @@ -118,7 +118,7 @@ func main() { [[Back to top]](#) ## delete-scheduled-search -Delete a Scheduled Search +Delete a scheduled search Deletes the specified scheduled search. @@ -184,7 +184,7 @@ func main() { [[Back to top]](#) ## get-scheduled-search -Get a Scheduled Search +Get a scheduled search Returns the specified scheduled search. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-scheduled-search) @@ -319,7 +319,7 @@ func main() { [[Back to top]](#) ## unsubscribe-scheduled-search -Unsubscribe a recipient from Scheduled Search +Unsubscribe a recipient from scheduled search Unsubscribes a recipient from the specified scheduled search. @@ -395,7 +395,7 @@ func main() { [[Back to top]](#) ## update-scheduled-search -Update an existing Scheduled Search +Update an existing scheduled search Updates an existing scheduled search. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SearchAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SearchAPI.md index 5c81cdcff..8f71bdc23 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/SearchAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SearchAPI.md @@ -38,14 +38,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**search-aggregate**](#search-aggregate) | **Post** `/search/aggregate` | Perform a Search Query Aggregation -[**search-count**](#search-count) | **Post** `/search/count` | Count Documents Satisfying a Query -[**search-get**](#search-get) | **Get** `/search/{index}/{id}` | Get a Document by ID -[**search-post**](#search-post) | **Post** `/search` | Perform Search +[**search-aggregate**](#search-aggregate) | **Post** `/search/aggregate` | Perform a search query aggregation +[**search-count**](#search-count) | **Post** `/search/count` | Count documents satisfying a query +[**search-get**](#search-get) | **Get** `/search/{index}/{id}` | Get a document by id +[**search-post**](#search-post) | **Post** `/search` | Perform search ## search-aggregate -Perform a Search Query Aggregation +Perform a search query aggregation Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. [API Spec](https://developer.sailpoint.com/docs/api/v2025/search-aggregate) @@ -234,7 +234,7 @@ func main() { [[Back to top]](#) ## search-count -Count Documents Satisfying a Query +Count documents satisfying a query Performs a search with a provided query and returns the count of results in the X-Total-Count header. [API Spec](https://developer.sailpoint.com/docs/api/v2025/search-count) @@ -416,7 +416,7 @@ func main() { [[Back to top]](#) ## search-get -Get a Document by ID +Get a document by id Fetches a single document from the specified index, using the specified document ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/search-get) @@ -485,7 +485,7 @@ func main() { [[Back to top]](#) ## search-post -Perform Search +Perform search Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. [API Spec](https://developer.sailpoint.com/docs/api/v2025/search-post) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SearchAttributeConfigurationAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SearchAttributeConfigurationAPI.md index 38273e919..e826ca48a 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/SearchAttributeConfigurationAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SearchAttributeConfigurationAPI.md @@ -33,11 +33,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-search-attribute-config**](#create-search-attribute-config) | **Post** `/accounts/search-attribute-config` | Create Extended Search Attributes -[**delete-search-attribute-config**](#delete-search-attribute-config) | **Delete** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute -[**get-search-attribute-config**](#get-search-attribute-config) | **Get** `/accounts/search-attribute-config` | List Extended Search Attributes -[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **Get** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute -[**patch-search-attribute-config**](#patch-search-attribute-config) | **Patch** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute +[**create-search-attribute-config**](#create-search-attribute-config) | **Post** `/accounts/search-attribute-config` | Create extended search attributes +[**delete-search-attribute-config**](#delete-search-attribute-config) | **Delete** `/accounts/search-attribute-config/{name}` | Delete extended search attribute +[**get-search-attribute-config**](#get-search-attribute-config) | **Get** `/accounts/search-attribute-config` | List extended search attributes +[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **Get** `/accounts/search-attribute-config/{name}` | Get extended search attribute +[**patch-search-attribute-config**](#patch-search-attribute-config) | **Patch** `/accounts/search-attribute-config/{name}` | Update extended search attribute ## create-search-attribute-config @@ -52,7 +52,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create Extended Search Attributes +Create extended search attributes Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** @@ -140,7 +140,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Extended Search Attribute +Delete extended search attribute Delete an extended attribute configuration by name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-search-attribute-config) @@ -218,7 +218,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Extended Search Attributes +List extended search attributes Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-search-attribute-config) @@ -295,7 +295,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Extended Search Attribute +Get extended search attribute Get an extended attribute configuration by name. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-single-search-attribute-config) @@ -374,7 +374,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Extended Search Attribute +Update extended search attribute Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SegmentsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SegmentsAPI.md index 9d36c8e67..e59d81d5e 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/SegmentsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SegmentsAPI.md @@ -32,15 +32,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-segment**](#create-segment) | **Post** `/segments` | Create Segment -[**delete-segment**](#delete-segment) | **Delete** `/segments/{id}` | Delete Segment by ID -[**get-segment**](#get-segment) | **Get** `/segments/{id}` | Get Segment by ID -[**list-segments**](#list-segments) | **Get** `/segments` | List Segments -[**patch-segment**](#patch-segment) | **Patch** `/segments/{id}` | Update Segment +[**create-segment**](#create-segment) | **Post** `/segments` | Create segment +[**delete-segment**](#delete-segment) | **Delete** `/segments/{id}` | Delete segment by id +[**get-segment**](#get-segment) | **Get** `/segments/{id}` | Get segment by id +[**list-segments**](#list-segments) | **Get** `/segments` | List segments +[**patch-segment**](#patch-segment) | **Patch** `/segments/{id}` | Update segment ## create-segment -Create Segment +Create segment This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. @@ -131,7 +131,7 @@ func main() { [[Back to top]](#) ## delete-segment -Delete Segment by ID +Delete segment by id This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. @@ -197,7 +197,7 @@ func main() { [[Back to top]](#) ## get-segment -Get Segment by ID +Get segment by id This API returns the segment specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-segment) @@ -263,7 +263,7 @@ func main() { [[Back to top]](#) ## list-segments -List Segments +List segments This API returns a list of all segments. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-segments) @@ -329,7 +329,7 @@ func main() { [[Back to top]](#) ## patch-segment -Update Segment +Update segment Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ServiceDeskIntegrationAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ServiceDeskIntegrationAPI.md index 93ba1a6eb..3071dbe35 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/ServiceDeskIntegrationAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ServiceDeskIntegrationAPI.md @@ -39,20 +39,20 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-service-desk-integration**](#create-service-desk-integration) | **Post** `/service-desk-integrations` | Create new Service Desk integration -[**delete-service-desk-integration**](#delete-service-desk-integration) | **Delete** `/service-desk-integrations/{id}` | Delete a Service Desk integration -[**get-service-desk-integration**](#get-service-desk-integration) | **Get** `/service-desk-integrations/{id}` | Get a Service Desk integration -[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **Get** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName -[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **Get** `/service-desk-integrations/types` | List Service Desk integration types -[**get-service-desk-integrations**](#get-service-desk-integrations) | **Get** `/service-desk-integrations` | List existing Service Desk integrations +[**create-service-desk-integration**](#create-service-desk-integration) | **Post** `/service-desk-integrations` | Create new service desk integration +[**delete-service-desk-integration**](#delete-service-desk-integration) | **Delete** `/service-desk-integrations/{id}` | Delete a service desk integration +[**get-service-desk-integration**](#get-service-desk-integration) | **Get** `/service-desk-integrations/{id}` | Get a service desk integration +[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **Get** `/service-desk-integrations/templates/{scriptName}` | Service desk integration template by scriptname +[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **Get** `/service-desk-integrations/types` | List service desk integration types +[**get-service-desk-integrations**](#get-service-desk-integrations) | **Get** `/service-desk-integrations` | List existing service desk integrations [**get-status-check-details**](#get-status-check-details) | **Get** `/service-desk-integrations/status-check-configuration` | Get the time check configuration -[**patch-service-desk-integration**](#patch-service-desk-integration) | **Patch** `/service-desk-integrations/{id}` | Patch a Service Desk Integration -[**put-service-desk-integration**](#put-service-desk-integration) | **Put** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**patch-service-desk-integration**](#patch-service-desk-integration) | **Patch** `/service-desk-integrations/{id}` | Patch a service desk integration +[**put-service-desk-integration**](#put-service-desk-integration) | **Put** `/service-desk-integrations/{id}` | Update a service desk integration [**update-status-check-details**](#update-status-check-details) | **Put** `/service-desk-integrations/status-check-configuration` | Update the time check configuration ## create-service-desk-integration -Create new Service Desk integration +Create new service desk integration Create a new Service Desk integration. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-service-desk-integration) @@ -152,7 +152,7 @@ func main() { [[Back to top]](#) ## delete-service-desk-integration -Delete a Service Desk integration +Delete a service desk integration Delete an existing Service Desk integration by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-service-desk-integration) @@ -217,7 +217,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integration -Get a Service Desk integration +Get a service desk integration Get an existing Service Desk integration by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-service-desk-integration) @@ -283,7 +283,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integration-template -Service Desk integration template by scriptName +Service desk integration template by scriptname This API endpoint returns an existing Service Desk integration template by scriptName. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-service-desk-integration-template) @@ -349,7 +349,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integration-types -List Service Desk integration types +List service desk integration types This API endpoint returns the current list of supported Service Desk integration types. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-service-desk-integration-types) @@ -406,7 +406,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integrations -List existing Service Desk integrations +List existing service desk integrations Get a list of Service Desk integration objects. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-service-desk-integrations) @@ -533,7 +533,7 @@ func main() { [[Back to top]](#) ## patch-service-desk-integration -Patch a Service Desk Integration +Patch a service desk integration Update an existing Service Desk integration by ID with a PATCH request. [API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-service-desk-integration) @@ -606,7 +606,7 @@ func main() { [[Back to top]](#) ## put-service-desk-integration -Update a Service Desk integration +Update a service desk integration Update an existing Service Desk integration by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-service-desk-integration) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SourcesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SourcesAPI.md index f5cf0a375..a7db9ac6c 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/SourcesAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SourcesAPI.md @@ -72,60 +72,60 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-provisioning-policy**](#create-provisioning-policy) | **Post** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy -[**create-source**](#create-source) | **Post** `/sources` | Creates a source in IdentityNow. -[**create-source-schedule**](#create-source-schedule) | **Post** `/sources/{sourceId}/schedules` | Create Schedule on Source -[**create-source-schema**](#create-source-schema) | **Post** `/sources/{sourceId}/schemas` | Create Schema on Source -[**delete-accounts-async**](#delete-accounts-async) | **Post** `/sources/{id}/remove-accounts` | Remove All Accounts in a Source -[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **Delete** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration -[**delete-provisioning-policy**](#delete-provisioning-policy) | **Delete** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType -[**delete-source**](#delete-source) | **Delete** `/sources/{id}` | Delete Source by ID -[**delete-source-schedule**](#delete-source-schedule) | **Delete** `/sources/{sourceId}/schedules/{scheduleType}` | Delete Source Schedule by type. -[**delete-source-schema**](#delete-source-schema) | **Delete** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**create-provisioning-policy**](#create-provisioning-policy) | **Post** `/sources/{sourceId}/provisioning-policies` | Create provisioning policy +[**create-source**](#create-source) | **Post** `/sources` | Creates a source in identitynow. +[**create-source-schedule**](#create-source-schedule) | **Post** `/sources/{sourceId}/schedules` | Create schedule on source +[**create-source-schema**](#create-source-schema) | **Post** `/sources/{sourceId}/schemas` | Create schema on source +[**delete-accounts-async**](#delete-accounts-async) | **Post** `/sources/{id}/remove-accounts` | Remove all accounts in a source +[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **Delete** `/sources/{sourceId}/native-change-detection-config` | Delete native change detection configuration +[**delete-provisioning-policy**](#delete-provisioning-policy) | **Delete** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype +[**delete-source**](#delete-source) | **Delete** `/sources/{id}` | Delete source by id +[**delete-source-schedule**](#delete-source-schedule) | **Delete** `/sources/{sourceId}/schedules/{scheduleType}` | Delete source schedule by type. +[**delete-source-schema**](#delete-source-schema) | **Delete** `/sources/{sourceId}/schemas/{schemaId}` | Delete source schema by id [**get-accounts-schema**](#get-accounts-schema) | **Get** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template -[**get-correlation-config**](#get-correlation-config) | **Get** `/sources/{id}/correlation-config` | Get Source Correlation Configuration +[**get-correlation-config**](#get-correlation-config) | **Get** `/sources/{id}/correlation-config` | Get source correlation configuration [**get-entitlements-schema**](#get-entitlements-schema) | **Get** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template -[**get-native-change-detection-config**](#get-native-change-detection-config) | **Get** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration -[**get-provisioning-policy**](#get-provisioning-policy) | **Get** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType -[**get-source**](#get-source) | **Get** `/sources/{id}` | Get Source by ID -[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **Get** `/sources/{id}/attribute-sync-config` | Attribute Sync Config +[**get-native-change-detection-config**](#get-native-change-detection-config) | **Get** `/sources/{sourceId}/native-change-detection-config` | Native change detection configuration +[**get-provisioning-policy**](#get-provisioning-policy) | **Get** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype +[**get-source**](#get-source) | **Get** `/sources/{id}` | Get source by id +[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **Get** `/sources/{id}/attribute-sync-config` | Attribute sync config [**get-source-config**](#get-source-config) | **Get** `/sources/{id}/connectors/source-config` | Gets source config with language-translations -[**get-source-connections**](#get-source-connections) | **Get** `/sources/{sourceId}/connections` | Get Source Connections by ID -[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **Get** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration +[**get-source-connections**](#get-source-connections) | **Get** `/sources/{sourceId}/connections` | Get source connections by id +[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **Get** `/sources/{id}/entitlement-request-config` | Get source entitlement request configuration [**get-source-health**](#get-source-health) | **Get** `/sources/{sourceId}/source-health` | Fetches source health by id -[**get-source-schedule**](#get-source-schedule) | **Get** `/sources/{sourceId}/schedules/{scheduleType}` | Get Source Schedule by Type -[**get-source-schedules**](#get-source-schedules) | **Get** `/sources/{sourceId}/schedules` | List Schedules on Source -[**get-source-schema**](#get-source-schema) | **Get** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID -[**get-source-schemas**](#get-source-schemas) | **Get** `/sources/{sourceId}/schemas` | List Schemas on Source -[**import-accounts**](#import-accounts) | **Post** `/sources/{id}/load-accounts` | Account Aggregation +[**get-source-schedule**](#get-source-schedule) | **Get** `/sources/{sourceId}/schedules/{scheduleType}` | Get source schedule by type +[**get-source-schedules**](#get-source-schedules) | **Get** `/sources/{sourceId}/schedules` | List schedules on source +[**get-source-schema**](#get-source-schema) | **Get** `/sources/{sourceId}/schemas/{schemaId}` | Get source schema by id +[**get-source-schemas**](#get-source-schemas) | **Get** `/sources/{sourceId}/schemas` | List schemas on source +[**import-accounts**](#import-accounts) | **Post** `/sources/{id}/load-accounts` | Account aggregation [**import-accounts-schema**](#import-accounts-schema) | **Post** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template [**import-connector-file**](#import-connector-file) | **Post** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source [**import-entitlements-schema**](#import-entitlements-schema) | **Post** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template -[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **Post** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts -[**list-provisioning-policies**](#list-provisioning-policies) | **Get** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies -[**list-sources**](#list-sources) | **Get** `/sources` | Lists all sources in IdentityNow. +[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **Post** `/sources/{id}/load-uncorrelated-accounts` | Process uncorrelated accounts +[**list-provisioning-policies**](#list-provisioning-policies) | **Get** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies +[**list-sources**](#list-sources) | **Get** `/sources` | Lists all sources in identitynow. [**ping-cluster**](#ping-cluster) | **Post** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector -[**put-correlation-config**](#put-correlation-config) | **Put** `/sources/{id}/correlation-config` | Update Source Correlation Configuration -[**put-native-change-detection-config**](#put-native-change-detection-config) | **Put** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration -[**put-provisioning-policy**](#put-provisioning-policy) | **Put** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType -[**put-source**](#put-source) | **Put** `/sources/{id}` | Update Source (Full) -[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **Put** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config -[**put-source-schema**](#put-source-schema) | **Put** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**put-correlation-config**](#put-correlation-config) | **Put** `/sources/{id}/correlation-config` | Update source correlation configuration +[**put-native-change-detection-config**](#put-native-change-detection-config) | **Put** `/sources/{sourceId}/native-change-detection-config` | Update native change detection configuration +[**put-provisioning-policy**](#put-provisioning-policy) | **Put** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype +[**put-source**](#put-source) | **Put** `/sources/{id}` | Update source (full) +[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **Put** `/sources/{id}/attribute-sync-config` | Update attribute sync config +[**put-source-schema**](#put-source-schema) | **Put** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (full) [**search-resource-objects**](#search-resource-objects) | **Post** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects [**sync-attributes-for-source**](#sync-attributes-for-source) | **Post** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes. [**test-source-configuration**](#test-source-configuration) | **Post** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector [**test-source-connection**](#test-source-connection) | **Post** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector. -[**update-password-policy-holders**](#update-password-policy-holders) | **Patch** `/sources/{sourceId}/password-policies` | Update Password Policy -[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **Post** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies -[**update-provisioning-policy**](#update-provisioning-policy) | **Patch** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy -[**update-source**](#update-source) | **Patch** `/sources/{id}` | Update Source (Partial) -[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **Put** `/sources/{id}/entitlement-request-config` | Update Source Entitlement Request Configuration -[**update-source-schedule**](#update-source-schedule) | **Patch** `/sources/{sourceId}/schedules/{scheduleType}` | Update Source Schedule (Partial) -[**update-source-schema**](#update-source-schema) | **Patch** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) +[**update-password-policy-holders**](#update-password-policy-holders) | **Patch** `/sources/{sourceId}/password-policies` | Update password policy +[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **Post** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies +[**update-provisioning-policy**](#update-provisioning-policy) | **Patch** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy +[**update-source**](#update-source) | **Patch** `/sources/{id}` | Update source (partial) +[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **Put** `/sources/{id}/entitlement-request-config` | Update source entitlement request configuration +[**update-source-schedule**](#update-source-schedule) | **Patch** `/sources/{sourceId}/schedules/{scheduleType}` | Update source schedule (partial) +[**update-source-schema**](#update-source-schema) | **Patch** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (partial) ## create-provisioning-policy -Create Provisioning Policy +Create provisioning policy This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. @@ -239,7 +239,7 @@ func main() { [[Back to top]](#) ## create-source -Creates a source in IdentityNow. +Creates a source in identitynow. This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-source) @@ -390,7 +390,7 @@ func main() { [[Back to top]](#) ## create-source-schedule -Create Schedule on Source +Create schedule on source Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). @@ -464,7 +464,7 @@ func main() { [[Back to top]](#) ## create-source-schema -Create Schema on Source +Create schema on source Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). @@ -582,7 +582,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Remove All Accounts in a Source +Remove all accounts in a source Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: @@ -667,7 +667,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Native Change Detection Configuration +Delete native change detection configuration Deletes the native change detection configuration for the source specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-native-change-detection-config) @@ -734,7 +734,7 @@ func main() { [[Back to top]](#) ## delete-provisioning-policy -Delete Provisioning Policy by UsageType +Delete provisioning policy by usagetype Deletes the provisioning policy with the specified usage on an application. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-provisioning-policy) @@ -802,7 +802,7 @@ func main() { [[Back to top]](#) ## delete-source -Delete Source by ID +Delete source by id Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` @@ -869,7 +869,7 @@ func main() { [[Back to top]](#) ## delete-source-schedule -Delete Source Schedule by type. +Delete source schedule by type. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-source-schedule) @@ -937,7 +937,7 @@ func main() { [[Back to top]](#) ## delete-source-schema -Delete Source Schema by ID +Delete source schema by id [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-source-schema) @@ -1071,7 +1071,7 @@ func main() { [[Back to top]](#) ## get-correlation-config -Get Source Correlation Configuration +Get source correlation configuration This API returns the existing correlation configuration for a source specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-correlation-config) @@ -1217,7 +1217,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Native Change Detection Configuration +Native change detection configuration This API returns the existing native change detection configuration for a source specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-native-change-detection-config) @@ -1285,7 +1285,7 @@ func main() { [[Back to top]](#) ## get-provisioning-policy -Get Provisioning Policy by UsageType +Get provisioning policy by usagetype This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-provisioning-policy) @@ -1354,7 +1354,7 @@ func main() { [[Back to top]](#) ## get-source -Get Source by ID +Get source by id Use this API to get a source by a specified ID in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source) @@ -1431,7 +1431,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Attribute Sync Config +Attribute sync config This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-attr-sync-config) @@ -1567,7 +1567,7 @@ func main() { [[Back to top]](#) ## get-source-connections -Get Source Connections by ID +Get source connections by id Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-connections) @@ -1644,7 +1644,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Source Entitlement Request Configuration +Get source entitlement request configuration This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. @@ -1776,7 +1776,7 @@ func main() { [[Back to top]](#) ## get-source-schedule -Get Source Schedule by Type +Get source schedule by type Get the source schedule by type in Identity Security Cloud (ISC). @@ -1846,7 +1846,7 @@ func main() { [[Back to top]](#) ## get-source-schedules -List Schedules on Source +List schedules on source Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. @@ -1920,7 +1920,7 @@ func main() { [[Back to top]](#) ## get-source-schema -Get Source Schema by ID +Get source schema by id Get the Source Schema by ID in IdentityNow. @@ -1990,7 +1990,7 @@ func main() { [[Back to top]](#) ## get-source-schemas -List Schemas on Source +List schemas on source Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-schemas) @@ -2060,7 +2060,7 @@ func main() { [[Back to top]](#) ## import-accounts -Account Aggregation +Account aggregation Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. @@ -2361,7 +2361,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Process Uncorrelated Accounts +Process uncorrelated accounts File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` [API Spec](https://developer.sailpoint.com/docs/api/v2025/import-uncorrelated-accounts) @@ -2431,7 +2431,7 @@ func main() { [[Back to top]](#) ## list-provisioning-policies -Lists ProvisioningPolicies +Lists provisioningpolicies This end-point lists all the ProvisioningPolicies in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-provisioning-policies) @@ -2497,7 +2497,7 @@ func main() { [[Back to top]](#) ## list-sources -Lists all sources in IdentityNow. +Lists all sources in identitynow. This end-point lists all the sources in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-sources) @@ -2637,7 +2637,7 @@ func main() { [[Back to top]](#) ## put-correlation-config -Update Source Correlation Configuration +Update source correlation configuration Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-correlation-config) @@ -2741,7 +2741,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Native Change Detection Configuration +Update native change detection configuration Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-native-change-detection-config) @@ -2823,7 +2823,7 @@ func main() { [[Back to top]](#) ## put-provisioning-policy -Update Provisioning Policy by UsageType +Update provisioning policy by usagetype This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. @@ -2940,7 +2940,7 @@ func main() { [[Back to top]](#) ## put-source -Update Source (Full) +Update source (full) Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: @@ -3118,7 +3118,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Attribute Sync Config +Update attribute sync config Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. @@ -3211,7 +3211,7 @@ func main() { [[Back to top]](#) ## put-source-schema -Update Source Schema (Full) +Update source schema (full) This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id @@ -3617,7 +3617,7 @@ func main() { [[Back to top]](#) ## update-password-policy-holders -Update Password Policy +Update password policy This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. @@ -3692,7 +3692,7 @@ func main() { [[Back to top]](#) ## update-provisioning-policies-in-bulk -Bulk Update Provisioning Policies +Bulk update provisioning policies This end-point updates a list of provisioning policies on the specified source in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v2025/update-provisioning-policies-in-bulk) @@ -3765,7 +3765,7 @@ func main() { [[Back to top]](#) ## update-provisioning-policy -Partial update of Provisioning Policy +Partial update of provisioning policy This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. @@ -3843,7 +3843,7 @@ func main() { [[Back to top]](#) ## update-source -Update Source (Partial) +Update source (partial) Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. @@ -3942,7 +3942,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Source Entitlement Request Configuration +Update source entitlement request configuration This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. @@ -4037,7 +4037,7 @@ func main() { [[Back to top]](#) ## update-source-schedule -Update Source Schedule (Partial) +Update source schedule (partial) Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: @@ -4118,7 +4118,7 @@ func main() { [[Back to top]](#) ## update-source-schema -Update Source Schema (Partial) +Update source schema (partial) Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SuggestedEntitlementDescriptionAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SuggestedEntitlementDescriptionAPI.md index f6c0ba63d..ba82299d4 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/SuggestedEntitlementDescriptionAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SuggestedEntitlementDescriptionAPI.md @@ -18,17 +18,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-sed-batch-stats**](#get-sed-batch-stats) | **Get** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request -[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List Sed Batch Request -[**list-seds**](#list-seds) | **Get** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions -[**patch-sed**](#patch-sed) | **Patch** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description -[**submit-sed-approval**](#submit-sed-approval) | **Post** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request -[**submit-sed-assignment**](#submit-sed-assignment) | **Post** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request -[**submit-sed-batch-request**](#submit-sed-batch-request) | **Post** `/suggested-entitlement-description-batches` | Submit Sed Batch Request +[**get-sed-batch-stats**](#get-sed-batch-stats) | **Get** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit sed batch stats request +[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List sed batch request +[**list-seds**](#list-seds) | **Get** `/suggested-entitlement-descriptions` | List suggested entitlement descriptions +[**patch-sed**](#patch-sed) | **Patch** `/suggested-entitlement-descriptions` | Patch suggested entitlement description +[**submit-sed-approval**](#submit-sed-approval) | **Post** `/suggested-entitlement-description-approvals` | Submit bulk approval request +[**submit-sed-assignment**](#submit-sed-assignment) | **Post** `/suggested-entitlement-description-assignments` | Submit sed assignment request +[**submit-sed-batch-request**](#submit-sed-batch-request) | **Post** `/suggested-entitlement-description-batches` | Submit sed batch request ## get-sed-batch-stats -Submit Sed Batch Stats Request +Submit sed batch stats request 'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats @@ -98,7 +98,7 @@ func main() { [[Back to top]](#) ## get-sed-batches -List Sed Batch Request +List sed batch request List Sed Batches. API responses with Sed Batch Status @@ -156,7 +156,7 @@ func main() { [[Back to top]](#) ## list-seds -List Suggested Entitlement Descriptions +List suggested entitlement descriptions List of Suggested Entitlement Descriptions (SED) SED field descriptions: @@ -246,7 +246,7 @@ func main() { [[Back to top]](#) ## patch-sed -Patch Suggested Entitlement Description +Patch suggested entitlement description Patch Suggested Entitlement Description [API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-sed) @@ -319,7 +319,7 @@ func main() { [[Back to top]](#) ## submit-sed-approval -Submit Bulk Approval Request +Submit bulk approval request Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status @@ -387,7 +387,7 @@ func main() { [[Back to top]](#) ## submit-sed-assignment -Submit Sed Assignment Request +Submit sed assignment request Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together @@ -461,7 +461,7 @@ func main() { [[Back to top]](#) ## submit-sed-batch-request -Submit Sed Batch Request +Submit sed batch request Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/TaggedObjectsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/TaggedObjectsAPI.md index 5d3c84dc3..d499f398f 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/TaggedObjectsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/TaggedObjectsAPI.md @@ -68,18 +68,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**delete-tagged-object**](#delete-tagged-object) | **Delete** `/tagged-objects/{type}/{id}` | Delete Object Tags -[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **Post** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects -[**get-tagged-object**](#get-tagged-object) | **Get** `/tagged-objects/{type}/{id}` | Get Tagged Object -[**list-tagged-objects**](#list-tagged-objects) | **Get** `/tagged-objects` | List Tagged Objects -[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **Get** `/tagged-objects/{type}` | List Tagged Objects by Type -[**put-tagged-object**](#put-tagged-object) | **Put** `/tagged-objects/{type}/{id}` | Update Tagged Object -[**set-tag-to-object**](#set-tag-to-object) | **Post** `/tagged-objects` | Add Tag to Object -[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **Post** `/tagged-objects/bulk-add` | Tag Multiple Objects +[**delete-tagged-object**](#delete-tagged-object) | **Delete** `/tagged-objects/{type}/{id}` | Delete object tags +[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **Post** `/tagged-objects/bulk-remove` | Remove tags from multiple objects +[**get-tagged-object**](#get-tagged-object) | **Get** `/tagged-objects/{type}/{id}` | Get tagged object +[**list-tagged-objects**](#list-tagged-objects) | **Get** `/tagged-objects` | List tagged objects +[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **Get** `/tagged-objects/{type}` | List tagged objects by type +[**put-tagged-object**](#put-tagged-object) | **Put** `/tagged-objects/{type}/{id}` | Update tagged object +[**set-tag-to-object**](#set-tag-to-object) | **Post** `/tagged-objects` | Add tag to object +[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **Post** `/tagged-objects/bulk-add` | Tag multiple objects ## delete-tagged-object -Delete Object Tags +Delete object tags Delete all tags from a tagged object. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-tagged-object) @@ -147,7 +147,7 @@ func main() { [[Back to top]](#) ## delete-tags-to-many-object -Remove Tags from Multiple Objects +Remove tags from multiple objects This API removes tags from multiple objects. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-tags-to-many-object) @@ -224,7 +224,7 @@ func main() { [[Back to top]](#) ## get-tagged-object -Get Tagged Object +Get tagged object This gets a tagged object for the specified type. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-tagged-object) @@ -293,7 +293,7 @@ func main() { [[Back to top]](#) ## list-tagged-objects -List Tagged Objects +List tagged objects This API returns a list of all tagged objects. Any authenticated token may be used to call this API. @@ -363,7 +363,7 @@ func main() { [[Back to top]](#) ## list-tagged-objects-by-type -List Tagged Objects by Type +List tagged objects by type This API returns a list of all tagged objects by type. Any authenticated token may be used to call this API. @@ -439,7 +439,7 @@ func main() { [[Back to top]](#) ## put-tagged-object -Update Tagged Object +Update tagged object This updates a tagged object for the specified type. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-tagged-object) @@ -522,7 +522,7 @@ func main() { [[Back to top]](#) ## set-tag-to-object -Add Tag to Object +Add tag to object This adds a tag to an object. Any authenticated token may be used to call this API. @@ -597,7 +597,7 @@ func main() { [[Back to top]](#) ## set-tags-to-many-objects -Tag Multiple Objects +Tag multiple objects This API adds tags to multiple objects. [API Spec](https://developer.sailpoint.com/docs/api/v2025/set-tags-to-many-objects) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/TaskManagementAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/TaskManagementAPI.md index 6a04f63f4..42417bf0f 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/TaskManagementAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/TaskManagementAPI.md @@ -15,11 +15,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-pending-task-headers**](#get-pending-task-headers) | **Head** `/task-status/pending-tasks` | Retrieve Pending Task List Headers -[**get-pending-tasks**](#get-pending-tasks) | **Get** `/task-status/pending-tasks` | Retrieve Pending Task Status List -[**get-task-status**](#get-task-status) | **Get** `/task-status/{id}` | Get Task Status by ID -[**get-task-status-list**](#get-task-status-list) | **Get** `/task-status` | Retrieve Task Status List -[**update-task-status**](#update-task-status) | **Patch** `/task-status/{id}` | Update Task Status by ID +[**get-pending-task-headers**](#get-pending-task-headers) | **Head** `/task-status/pending-tasks` | Retrieve pending task list headers +[**get-pending-tasks**](#get-pending-tasks) | **Get** `/task-status/pending-tasks` | Retrieve pending task status list +[**get-task-status**](#get-task-status) | **Get** `/task-status/{id}` | Get task status by id +[**get-task-status-list**](#get-task-status-list) | **Get** `/task-status` | Retrieve task status list +[**update-task-status**](#update-task-status) | **Patch** `/task-status/{id}` | Update task status by id ## get-pending-task-headers @@ -34,7 +34,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Retrieve Pending Task List Headers +Retrieve pending task list headers Responds with headers only for list of task statuses for pending tasks. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-pending-task-headers) @@ -112,7 +112,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Retrieve Pending Task Status List +Retrieve pending task status list Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-pending-tasks) @@ -191,7 +191,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Task Status by ID +Get task status by id Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-task-status) @@ -270,7 +270,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Retrieve Task Status List +Retrieve task status list Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. @@ -354,7 +354,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Task Status by ID +Update task status by id Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. [API Spec](https://developer.sailpoint.com/docs/api/v2025/update-task-status) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/TenantAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/TenantAPI.md index e2b6d36aa..5d77ffd01 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/TenantAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/TenantAPI.md @@ -15,11 +15,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-tenant**](#get-tenant) | **Get** `/tenant` | Get Tenant Information. +[**get-tenant**](#get-tenant) | **Get** `/tenant` | Get tenant information. ## get-tenant -Get Tenant Information. +Get tenant information. This rest endpoint can be used to retrieve tenant details. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-tenant) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/TransformsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/TransformsAPI.md index fb2e6ecb9..11ddd7b22 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/TransformsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/TransformsAPI.md @@ -22,7 +22,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create-transform**](#create-transform) | **Post** `/transforms` | Create transform [**delete-transform**](#delete-transform) | **Delete** `/transforms/{id}` | Delete a transform -[**get-transform**](#get-transform) | **Get** `/transforms/{id}` | Transform by ID +[**get-transform**](#get-transform) | **Get** `/transforms/{id}` | Transform by id [**list-transforms**](#list-transforms) | **Get** `/transforms` | List transforms [**update-transform**](#update-transform) | **Put** `/transforms/{id}` | Update a transform @@ -164,7 +164,7 @@ func main() { [[Back to top]](#) ## get-transform -Transform by ID +Transform by id This API returns the transform specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-transform) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/TriggersAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/TriggersAPI.md index 76335556e..16583cdb2 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/TriggersAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/TriggersAPI.md @@ -56,16 +56,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**complete-trigger-invocation**](#complete-trigger-invocation) | **Post** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation -[**create-subscription**](#create-subscription) | **Post** `/trigger-subscriptions` | Create a Subscription -[**delete-subscription**](#delete-subscription) | **Delete** `/trigger-subscriptions/{id}` | Delete a Subscription -[**list-subscriptions**](#list-subscriptions) | **Get** `/trigger-subscriptions` | List Subscriptions -[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **Get** `/trigger-invocations/status` | List Latest Invocation Statuses -[**list-triggers**](#list-triggers) | **Get** `/triggers` | List Triggers -[**patch-subscription**](#patch-subscription) | **Patch** `/trigger-subscriptions/{id}` | Patch a Subscription -[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **Post** `/trigger-invocations/test` | Start a Test Invocation -[**test-subscription-filter**](#test-subscription-filter) | **Post** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter -[**update-subscription**](#update-subscription) | **Put** `/trigger-subscriptions/{id}` | Update a Subscription +[**complete-trigger-invocation**](#complete-trigger-invocation) | **Post** `/trigger-invocations/{id}/complete` | Complete trigger invocation +[**create-subscription**](#create-subscription) | **Post** `/trigger-subscriptions` | Create a subscription +[**delete-subscription**](#delete-subscription) | **Delete** `/trigger-subscriptions/{id}` | Delete a subscription +[**list-subscriptions**](#list-subscriptions) | **Get** `/trigger-subscriptions` | List subscriptions +[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **Get** `/trigger-invocations/status` | List latest invocation statuses +[**list-triggers**](#list-triggers) | **Get** `/triggers` | List triggers +[**patch-subscription**](#patch-subscription) | **Patch** `/trigger-subscriptions/{id}` | Patch a subscription +[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **Post** `/trigger-invocations/test` | Start a test invocation +[**test-subscription-filter**](#test-subscription-filter) | **Post** `/trigger-subscriptions/validate-filter` | Validate a subscription filter +[**update-subscription**](#update-subscription) | **Put** `/trigger-subscriptions/{id}` | Update a subscription ## complete-trigger-invocation @@ -80,7 +80,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Complete Trigger Invocation +Complete trigger invocation Completes an invocation to a REQUEST_RESPONSE type trigger. [API Spec](https://developer.sailpoint.com/docs/api/v2025/complete-trigger-invocation) @@ -171,7 +171,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create a Subscription +Create a subscription This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig @@ -277,7 +277,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete a Subscription +Delete a subscription Deletes an existing subscription to a trigger. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-subscription) @@ -355,7 +355,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Subscriptions +List subscriptions Gets a list of all trigger subscriptions. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-subscriptions) @@ -438,7 +438,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Latest Invocation Statuses +List latest invocation statuses Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. @@ -523,7 +523,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Triggers +List triggers Gets a list of triggers that are available in the tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-triggers) @@ -606,7 +606,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Patch a Subscription +Patch a subscription This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** @@ -694,7 +694,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Start a Test Invocation +Start a test invocation Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. [API Spec](https://developer.sailpoint.com/docs/api/v2025/start-test-trigger-invocation) @@ -783,7 +783,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Validate a Subscription Filter +Validate a subscription filter Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: @@ -869,7 +869,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update a Subscription +Update a subscription This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/UIMetadataAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/UIMetadataAPI.md index 226cc100d..d690a118e 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/UIMetadataAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/UIMetadataAPI.md @@ -16,8 +16,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-tenant-ui-metadata**](#get-tenant-ui-metadata) | **Get** `/ui-metadata/tenant` | Get a tenant UI metadata -[**set-tenant-ui-metadata**](#set-tenant-ui-metadata) | **Put** `/ui-metadata/tenant` | Update tenant UI metadata +[**get-tenant-ui-metadata**](#get-tenant-ui-metadata) | **Get** `/ui-metadata/tenant` | Get a tenant ui metadata +[**set-tenant-ui-metadata**](#set-tenant-ui-metadata) | **Put** `/ui-metadata/tenant` | Update tenant ui metadata ## get-tenant-ui-metadata @@ -32,7 +32,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get a tenant UI metadata +Get a tenant ui metadata This API endpoint retrieves UI metadata configured for your tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-tenant-ui-metadata) @@ -105,7 +105,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update tenant UI metadata +Update tenant ui metadata This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. [API Spec](https://developer.sailpoint.com/docs/api/v2025/set-tenant-ui-metadata) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/VendorConnectorMappingsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/VendorConnectorMappingsAPI.md index c2aa20dd9..296e13cd7 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/VendorConnectorMappingsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/VendorConnectorMappingsAPI.md @@ -19,13 +19,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **Post** `/vendor-connector-mappings` | Create Vendor Connector Mapping -[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **Delete** `/vendor-connector-mappings` | Delete Vendor Connector Mapping -[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **Get** `/vendor-connector-mappings` | List Vendor Connector Mappings +[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **Post** `/vendor-connector-mappings` | Create vendor connector mapping +[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **Delete** `/vendor-connector-mappings` | Delete vendor connector mapping +[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **Get** `/vendor-connector-mappings` | List vendor connector mappings ## create-vendor-connector-mapping -Create Vendor Connector Mapping +Create vendor connector mapping Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. @@ -115,7 +115,7 @@ func main() { [[Back to top]](#) ## delete-vendor-connector-mapping -Delete Vendor Connector Mapping +Delete vendor connector mapping Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. @@ -205,7 +205,7 @@ func main() { [[Back to top]](#) ## get-vendor-connector-mappings -List Vendor Connector Mappings +List vendor connector mappings Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/WorkItemsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/WorkItemsAPI.md index 29e9b6abc..245d51e57 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/WorkItemsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/WorkItemsAPI.md @@ -29,23 +29,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-approval-item**](#approve-approval-item) | **Post** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item -[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **Post** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items -[**complete-work-item**](#complete-work-item) | **Post** `/work-items/{id}` | Complete a Work Item -[**forward-work-item**](#forward-work-item) | **Post** `/work-items/{id}/forward` | Forward a Work Item -[**get-completed-work-items**](#get-completed-work-items) | **Get** `/work-items/completed` | Completed Work Items -[**get-count-completed-work-items**](#get-count-completed-work-items) | **Get** `/work-items/completed/count` | Count Completed Work Items -[**get-count-work-items**](#get-count-work-items) | **Get** `/work-items/count` | Count Work Items -[**get-work-item**](#get-work-item) | **Get** `/work-items/{id}` | Get a Work Item -[**get-work-items-summary**](#get-work-items-summary) | **Get** `/work-items/summary` | Work Items Summary -[**list-work-items**](#list-work-items) | **Get** `/work-items` | List Work Items -[**reject-approval-item**](#reject-approval-item) | **Post** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item -[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **Post** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items -[**submit-account-selection**](#submit-account-selection) | **Post** `/work-items/{id}/submit-account-selection` | Submit Account Selections +[**approve-approval-item**](#approve-approval-item) | **Post** `/work-items/{id}/approve/{approvalItemId}` | Approve an approval item +[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **Post** `/work-items/bulk-approve/{id}` | Bulk approve approval items +[**complete-work-item**](#complete-work-item) | **Post** `/work-items/{id}` | Complete a work item +[**forward-work-item**](#forward-work-item) | **Post** `/work-items/{id}/forward` | Forward a work item +[**get-completed-work-items**](#get-completed-work-items) | **Get** `/work-items/completed` | Completed work items +[**get-count-completed-work-items**](#get-count-completed-work-items) | **Get** `/work-items/completed/count` | Count completed work items +[**get-count-work-items**](#get-count-work-items) | **Get** `/work-items/count` | Count work items +[**get-work-item**](#get-work-item) | **Get** `/work-items/{id}` | Get a work item +[**get-work-items-summary**](#get-work-items-summary) | **Get** `/work-items/summary` | Work items summary +[**list-work-items**](#list-work-items) | **Get** `/work-items` | List work items +[**reject-approval-item**](#reject-approval-item) | **Post** `/work-items/{id}/reject/{approvalItemId}` | Reject an approval item +[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **Post** `/work-items/bulk-reject/{id}` | Bulk reject approval items +[**submit-account-selection**](#submit-account-selection) | **Post** `/work-items/{id}/submit-account-selection` | Submit account selections ## approve-approval-item -Approve an Approval Item +Approve an approval item This API approves an Approval Item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2025/approve-approval-item) @@ -114,7 +114,7 @@ func main() { [[Back to top]](#) ## approve-approval-items-in-bulk -Bulk approve Approval Items +Bulk approve approval items This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2025/approve-approval-items-in-bulk) @@ -180,7 +180,7 @@ func main() { [[Back to top]](#) ## complete-work-item -Complete a Work Item +Complete a work item This API completes a work item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2025/complete-work-item) @@ -259,7 +259,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Forward a Work Item +Forward a work item This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2025/forward-work-item) @@ -337,7 +337,7 @@ func main() { [[Back to top]](#) ## get-completed-work-items -Completed Work Items +Completed work items This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-completed-work-items) @@ -416,7 +416,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Count Completed Work Items +Count completed work items This gets a count of completed work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-count-completed-work-items) @@ -480,7 +480,7 @@ func main() { [[Back to top]](#) ## get-count-work-items -Count Work Items +Count work items This gets a count of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-count-work-items) @@ -542,7 +542,7 @@ func main() { [[Back to top]](#) ## get-work-item -Get a Work Item +Get a work item This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-work-item) @@ -608,7 +608,7 @@ func main() { [[Back to top]](#) ## get-work-items-summary -Work Items Summary +Work items summary This gets a summary of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-work-items-summary) @@ -670,7 +670,7 @@ func main() { [[Back to top]](#) ## list-work-items -List Work Items +List work items This gets a collection of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-work-items) @@ -738,7 +738,7 @@ func main() { [[Back to top]](#) ## reject-approval-item -Reject an Approval Item +Reject an approval item This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2025/reject-approval-item) @@ -807,7 +807,7 @@ func main() { [[Back to top]](#) ## reject-approval-items-in-bulk -Bulk reject Approval Items +Bulk reject approval items This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2025/reject-approval-items-in-bulk) @@ -873,7 +873,7 @@ func main() { [[Back to top]](#) ## submit-account-selection -Submit Account Selections +Submit account selections This API submits account selections. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v2025/submit-account-selection) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/WorkReassignmentAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/WorkReassignmentAPI.md index e0568d83d..13e74fd3c 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/WorkReassignmentAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/WorkReassignmentAPI.md @@ -25,15 +25,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-reassignment-configuration**](#create-reassignment-configuration) | **Post** `/reassignment-configurations` | Create a Reassignment Configuration -[**delete-reassignment-configuration**](#delete-reassignment-configuration) | **Delete** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration -[**get-evaluate-reassignment-configuration**](#get-evaluate-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration -[**get-reassignment-config-types**](#get-reassignment-config-types) | **Get** `/reassignment-configurations/types` | List Reassignment Config Types -[**get-reassignment-configuration**](#get-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration -[**get-tenant-config-configuration**](#get-tenant-config-configuration) | **Get** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings -[**list-reassignment-configurations**](#list-reassignment-configurations) | **Get** `/reassignment-configurations` | List Reassignment Configurations -[**put-reassignment-config**](#put-reassignment-config) | **Put** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration -[**put-tenant-configuration**](#put-tenant-configuration) | **Put** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings +[**create-reassignment-configuration**](#create-reassignment-configuration) | **Post** `/reassignment-configurations` | Create a reassignment configuration +[**delete-reassignment-configuration**](#delete-reassignment-configuration) | **Delete** `/reassignment-configurations/{identityId}/{configType}` | Delete reassignment configuration +[**get-evaluate-reassignment-configuration**](#get-evaluate-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate reassignment configuration +[**get-reassignment-config-types**](#get-reassignment-config-types) | **Get** `/reassignment-configurations/types` | List reassignment config types +[**get-reassignment-configuration**](#get-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}` | Get reassignment configuration +[**get-tenant-config-configuration**](#get-tenant-config-configuration) | **Get** `/reassignment-configurations/tenant-config` | Get tenant-wide reassignment configuration settings +[**list-reassignment-configurations**](#list-reassignment-configurations) | **Get** `/reassignment-configurations` | List reassignment configurations +[**put-reassignment-config**](#put-reassignment-config) | **Put** `/reassignment-configurations/{identityId}` | Update reassignment configuration +[**put-tenant-configuration**](#put-tenant-configuration) | **Put** `/reassignment-configurations/tenant-config` | Update tenant-wide reassignment configuration settings ## create-reassignment-configuration @@ -48,7 +48,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Create a Reassignment Configuration +Create a reassignment configuration Creates a new Reassignment Configuration for the specified identity. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-reassignment-configuration) @@ -134,7 +134,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Delete Reassignment Configuration +Delete reassignment configuration Deletes a single reassignment configuration for the specified identity [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-reassignment-configuration) @@ -215,7 +215,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Evaluate Reassignment Configuration +Evaluate reassignment configuration Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-evaluate-reassignment-configuration) @@ -299,7 +299,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Reassignment Config Types +List reassignment config types Gets a collection of types which are available in the Reassignment Configuration UI. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-reassignment-config-types) @@ -372,7 +372,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Reassignment Configuration +Get reassignment configuration Gets the Reassignment Configuration for an identity. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-reassignment-configuration) @@ -451,7 +451,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Get Tenant-wide Reassignment Configuration settings +Get tenant-wide reassignment configuration settings Gets the global Reassignment Configuration settings for the requestor's tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-tenant-config-configuration) @@ -524,7 +524,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -List Reassignment Configurations +List reassignment configurations Gets all Reassignment configuration for the current org. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-reassignment-configurations) @@ -597,7 +597,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Reassignment Configuration +Update reassignment configuration Replaces existing Reassignment configuration for an identity with the newly provided configuration. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-reassignment-config) @@ -689,7 +689,7 @@ This API is currently in an experimental state. The API is subject to change bas configuration.experimental = True ``` ::: -Update Tenant-wide Reassignment Configuration settings +Update tenant-wide reassignment configuration settings Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-tenant-configuration) diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/WorkflowsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/WorkflowsAPI.md index c4a02a934..5f819558a 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/WorkflowsAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/WorkflowsAPI.md @@ -16,28 +16,28 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**cancel-workflow-execution**](#cancel-workflow-execution) | **Post** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID -[**create-external-execute-workflow**](#create-external-execute-workflow) | **Post** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger -[**create-workflow**](#create-workflow) | **Post** `/workflows` | Create Workflow -[**create-workflow-external-trigger**](#create-workflow-external-trigger) | **Post** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client -[**delete-workflow**](#delete-workflow) | **Delete** `/workflows/{id}` | Delete Workflow By Id -[**get-workflow**](#get-workflow) | **Get** `/workflows/{id}` | Get Workflow By Id -[**get-workflow-execution**](#get-workflow-execution) | **Get** `/workflow-executions/{id}` | Get Workflow Execution -[**get-workflow-execution-history**](#get-workflow-execution-history) | **Get** `/workflow-executions/{id}/history` | Get Workflow Execution History -[**get-workflow-executions**](#get-workflow-executions) | **Get** `/workflows/{id}/executions` | List Workflow Executions -[**list-complete-workflow-library**](#list-complete-workflow-library) | **Get** `/workflow-library` | List Complete Workflow Library -[**list-workflow-library-actions**](#list-workflow-library-actions) | **Get** `/workflow-library/actions` | List Workflow Library Actions -[**list-workflow-library-operators**](#list-workflow-library-operators) | **Get** `/workflow-library/operators` | List Workflow Library Operators -[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **Get** `/workflow-library/triggers` | List Workflow Library Triggers -[**list-workflows**](#list-workflows) | **Get** `/workflows` | List Workflows -[**patch-workflow**](#patch-workflow) | **Patch** `/workflows/{id}` | Patch Workflow -[**put-workflow**](#put-workflow) | **Put** `/workflows/{id}` | Update Workflow -[**test-external-execute-workflow**](#test-external-execute-workflow) | **Post** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger -[**test-workflow**](#test-workflow) | **Post** `/workflows/{id}/test` | Test Workflow By Id +[**cancel-workflow-execution**](#cancel-workflow-execution) | **Post** `/workflow-executions/{id}/cancel` | Cancel workflow execution by id +[**create-external-execute-workflow**](#create-external-execute-workflow) | **Post** `/workflows/execute/external/{id}` | Execute workflow via external trigger +[**create-workflow**](#create-workflow) | **Post** `/workflows` | Create workflow +[**create-workflow-external-trigger**](#create-workflow-external-trigger) | **Post** `/workflows/{id}/external/oauth-clients` | Generate external trigger oauth client +[**delete-workflow**](#delete-workflow) | **Delete** `/workflows/{id}` | Delete workflow by id +[**get-workflow**](#get-workflow) | **Get** `/workflows/{id}` | Get workflow by id +[**get-workflow-execution**](#get-workflow-execution) | **Get** `/workflow-executions/{id}` | Get workflow execution +[**get-workflow-execution-history**](#get-workflow-execution-history) | **Get** `/workflow-executions/{id}/history` | Get workflow execution history +[**get-workflow-executions**](#get-workflow-executions) | **Get** `/workflows/{id}/executions` | List workflow executions +[**list-complete-workflow-library**](#list-complete-workflow-library) | **Get** `/workflow-library` | List complete workflow library +[**list-workflow-library-actions**](#list-workflow-library-actions) | **Get** `/workflow-library/actions` | List workflow library actions +[**list-workflow-library-operators**](#list-workflow-library-operators) | **Get** `/workflow-library/operators` | List workflow library operators +[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **Get** `/workflow-library/triggers` | List workflow library triggers +[**list-workflows**](#list-workflows) | **Get** `/workflows` | List workflows +[**patch-workflow**](#patch-workflow) | **Patch** `/workflows/{id}` | Patch workflow +[**put-workflow**](#put-workflow) | **Put** `/workflows/{id}` | Update workflow +[**test-external-execute-workflow**](#test-external-execute-workflow) | **Post** `/workflows/execute/external/{id}/test` | Test workflow via external trigger +[**test-workflow**](#test-workflow) | **Post** `/workflows/{id}/test` | Test workflow by id ## cancel-workflow-execution -Cancel Workflow Execution by ID +Cancel workflow execution by id Use this API to cancel a running workflow execution. [API Spec](https://developer.sailpoint.com/docs/api/v2025/cancel-workflow-execution) @@ -102,7 +102,7 @@ func main() { [[Back to top]](#) ## create-external-execute-workflow -Execute Workflow via External Trigger +Execute workflow via external trigger This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-external-execute-workflow) @@ -170,7 +170,7 @@ func main() { [[Back to top]](#) ## create-workflow -Create Workflow +Create workflow Create a new workflow with the desired trigger and steps specified in the request body. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-workflow) @@ -237,7 +237,7 @@ func main() { [[Back to top]](#) ## create-workflow-external-trigger -Generate External Trigger OAuth Client +Generate external trigger oauth client Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-workflow-external-trigger) @@ -303,7 +303,7 @@ func main() { [[Back to top]](#) ## delete-workflow -Delete Workflow By Id +Delete workflow by id Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-workflow) @@ -368,7 +368,7 @@ func main() { [[Back to top]](#) ## get-workflow -Get Workflow By Id +Get workflow by id Get a single workflow by id. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-workflow) @@ -434,7 +434,7 @@ func main() { [[Back to top]](#) ## get-workflow-execution -Get Workflow Execution +Get workflow execution Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-workflow-execution) @@ -500,7 +500,7 @@ func main() { [[Back to top]](#) ## get-workflow-execution-history -Get Workflow Execution History +Get workflow execution history Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-workflow-execution-history) @@ -566,7 +566,7 @@ func main() { [[Back to top]](#) ## get-workflow-executions -List Workflow Executions +List workflow executions Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. @@ -650,7 +650,7 @@ func main() { [[Back to top]](#) ## list-complete-workflow-library -List Complete Workflow Library +List complete workflow library This lists all triggers, actions, and operators in the library [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-complete-workflow-library) @@ -714,7 +714,7 @@ func main() { [[Back to top]](#) ## list-workflow-library-actions -List Workflow Library Actions +List workflow library actions This lists the workflow actions available to you. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-workflow-library-actions) @@ -780,7 +780,7 @@ func main() { [[Back to top]](#) ## list-workflow-library-operators -List Workflow Library Operators +List workflow library operators This lists the workflow operators available to you [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-workflow-library-operators) @@ -837,7 +837,7 @@ func main() { [[Back to top]](#) ## list-workflow-library-triggers -List Workflow Library Triggers +List workflow library triggers This lists the workflow triggers available to you [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-workflow-library-triggers) @@ -903,7 +903,7 @@ func main() { [[Back to top]](#) ## list-workflows -List Workflows +List workflows List all workflows in the tenant. [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-workflows) @@ -960,7 +960,7 @@ func main() { [[Back to top]](#) ## patch-workflow -Patch Workflow +Patch workflow Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. [API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-workflow) @@ -1033,7 +1033,7 @@ func main() { [[Back to top]](#) ## put-workflow -Update Workflow +Update workflow Perform a full update of a workflow. The updated workflow object is returned in the response. [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-workflow) @@ -1139,7 +1139,7 @@ func main() { [[Back to top]](#) ## test-external-execute-workflow -Test Workflow via External Trigger +Test workflow via external trigger Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. [API Spec](https://developer.sailpoint.com/docs/api/v2025/test-external-execute-workflow) @@ -1207,7 +1207,7 @@ func main() { [[Back to top]](#) ## test-workflow -Test Workflow By Id +Test workflow by id :::info Workflow must be disabled in order to use this endpoint. diff --git a/docs/tools/sdk/go/Reference/V3/Methods/AccessProfilesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/AccessProfilesAPI.md index 5eb5708f4..33b3e6410 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/AccessProfilesAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/AccessProfilesAPI.md @@ -49,17 +49,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-access-profile**](#create-access-profile) | **Post** `/access-profiles` | Create Access Profile -[**delete-access-profile**](#delete-access-profile) | **Delete** `/access-profiles/{id}` | Delete the specified Access Profile -[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-delete` | Delete Access Profile(s) -[**get-access-profile**](#get-access-profile) | **Get** `/access-profiles/{id}` | Get an Access Profile -[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **Get** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements -[**list-access-profiles**](#list-access-profiles) | **Get** `/access-profiles` | List Access Profiles -[**patch-access-profile**](#patch-access-profile) | **Patch** `/access-profiles/{id}` | Patch a specified Access Profile +[**create-access-profile**](#create-access-profile) | **Post** `/access-profiles` | Create access profile +[**delete-access-profile**](#delete-access-profile) | **Delete** `/access-profiles/{id}` | Delete the specified access profile +[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-delete` | Delete access profile(s) +[**get-access-profile**](#get-access-profile) | **Get** `/access-profiles/{id}` | Get an access profile +[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **Get** `/access-profiles/{id}/entitlements` | List access profile's entitlements +[**list-access-profiles**](#list-access-profiles) | **Get** `/access-profiles` | List access profiles +[**patch-access-profile**](#patch-access-profile) | **Patch** `/access-profiles/{id}` | Patch a specified access profile ## create-access-profile -Create Access Profile +Create access profile Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. @@ -214,7 +214,7 @@ func main() { [[Back to top]](#) ## delete-access-profile -Delete the specified Access Profile +Delete the specified access profile This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. @@ -283,7 +283,7 @@ func main() { [[Back to top]](#) ## delete-access-profiles-in-bulk -Delete Access Profile(s) +Delete access profile(s) This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. @@ -357,7 +357,7 @@ func main() { [[Back to top]](#) ## get-access-profile -Get an Access Profile +Get an access profile This API returns an Access Profile by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-profile) @@ -423,7 +423,7 @@ func main() { [[Back to top]](#) ## get-access-profile-entitlements -List Access Profile's Entitlements +List access profile's entitlements Use this API to get a list of an access profile's entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. @@ -501,7 +501,7 @@ func main() { [[Back to top]](#) ## list-access-profiles -List Access Profiles +List access profiles Get a list of access profiles. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. @@ -578,7 +578,7 @@ func main() { [[Back to top]](#) ## patch-access-profile -Patch a specified Access Profile +Patch a specified access profile This API updates an existing Access Profile. The following fields are patchable: **name** diff --git a/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestApprovalsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestApprovalsAPI.md index 5e40dc87b..bc3951b67 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestApprovalsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestApprovalsAPI.md @@ -32,16 +32,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-access-request**](#approve-access-request) | **Post** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval -[**forward-access-request**](#forward-access-request) | **Post** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval -[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **Get** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number -[**list-completed-approvals**](#list-completed-approvals) | **Get** `/access-request-approvals/completed` | Completed Access Request Approvals List -[**list-pending-approvals**](#list-pending-approvals) | **Get** `/access-request-approvals/pending` | Pending Access Request Approvals List -[**reject-access-request**](#reject-access-request) | **Post** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval +[**approve-access-request**](#approve-access-request) | **Post** `/access-request-approvals/{approvalId}/approve` | Approve access request approval +[**forward-access-request**](#forward-access-request) | **Post** `/access-request-approvals/{approvalId}/forward` | Forward access request approval +[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **Get** `/access-request-approvals/approval-summary` | Get access requests approvals number +[**list-completed-approvals**](#list-completed-approvals) | **Get** `/access-request-approvals/completed` | Completed access request approvals list +[**list-pending-approvals**](#list-pending-approvals) | **Get** `/access-request-approvals/pending` | Pending access request approvals list +[**reject-access-request**](#reject-access-request) | **Post** `/access-request-approvals/{approvalId}/reject` | Reject access request approval ## approve-access-request -Approve Access Request Approval +Approve access request approval Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. [API Spec](https://developer.sailpoint.com/docs/api/v3/approve-access-request) @@ -117,7 +117,7 @@ func main() { [[Back to top]](#) ## forward-access-request -Forward Access Request Approval +Forward access request approval Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. [API Spec](https://developer.sailpoint.com/docs/api/v3/forward-access-request) @@ -193,7 +193,7 @@ func main() { [[Back to top]](#) ## get-access-request-approval-summary -Get Access Requests Approvals Number +Get access requests approvals number Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-request-approval-summary) @@ -257,7 +257,7 @@ func main() { [[Back to top]](#) ## list-completed-approvals -Completed Access Request Approvals List +Completed access request approvals list This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-completed-approvals) @@ -329,7 +329,7 @@ func main() { [[Back to top]](#) ## list-pending-approvals -Pending Access Request Approvals List +Pending access request approvals list This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-pending-approvals) @@ -401,7 +401,7 @@ func main() { [[Back to top]](#) ## reject-access-request -Reject Access Request Approval +Reject access request approval Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. [API Spec](https://developer.sailpoint.com/docs/api/v3/reject-access-request) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestsAPI.md index 60b6a4807..d7c4c1172 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestsAPI.md @@ -30,15 +30,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**cancel-access-request**](#cancel-access-request) | **Post** `/access-requests/cancel` | Cancel Access Request -[**create-access-request**](#create-access-request) | **Post** `/access-requests` | Submit Access Request -[**get-access-request-config**](#get-access-request-config) | **Get** `/access-request-config` | Get Access Request Configuration -[**list-access-request-status**](#list-access-request-status) | **Get** `/access-request-status` | Access Request Status -[**set-access-request-config**](#set-access-request-config) | **Put** `/access-request-config` | Update Access Request Configuration +[**cancel-access-request**](#cancel-access-request) | **Post** `/access-requests/cancel` | Cancel access request +[**create-access-request**](#create-access-request) | **Post** `/access-requests` | Submit access request +[**get-access-request-config**](#get-access-request-config) | **Get** `/access-request-config` | Get access request configuration +[**list-access-request-status**](#list-access-request-status) | **Get** `/access-request-status` | Access request status +[**set-access-request-config**](#set-access-request-config) | **Put** `/access-request-config` | Update access request configuration ## cancel-access-request -Cancel Access Request +Cancel access request This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. @@ -109,7 +109,7 @@ func main() { [[Back to top]](#) ## create-access-request -Submit Access Request +Submit access request Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request @@ -391,7 +391,7 @@ func main() { [[Back to top]](#) ## get-access-request-config -Get Access Request Configuration +Get access request configuration This endpoint returns the current access-request configuration. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-request-config) @@ -448,7 +448,7 @@ func main() { [[Back to top]](#) ## list-access-request-status -Access Request Status +Access request status Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. @@ -530,7 +530,7 @@ func main() { [[Back to top]](#) ## set-access-request-config -Update Access Request Configuration +Update access request configuration This endpoint replaces the current access-request configuration. [API Spec](https://developer.sailpoint.com/docs/api/v3/set-access-request-config) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/AccountActivitiesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/AccountActivitiesAPI.md index eebbed188..be8acec7d 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/AccountActivitiesAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/AccountActivitiesAPI.md @@ -48,12 +48,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-account-activity**](#get-account-activity) | **Get** `/account-activities/{id}` | Get an Account Activity -[**list-account-activities**](#list-account-activities) | **Get** `/account-activities` | List Account Activities +[**get-account-activity**](#get-account-activity) | **Get** `/account-activities/{id}` | Get an account activity +[**list-account-activities**](#list-account-activities) | **Get** `/account-activities` | List account activities ## get-account-activity -Get an Account Activity +Get an account activity This gets a single account activity by its id. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-account-activity) @@ -119,7 +119,7 @@ func main() { [[Back to top]](#) ## list-account-activities -List Account Activities +List account activities This gets a collection of account activities that satisfy the given query parameters. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-account-activities) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/AccountsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/AccountsAPI.md index 741c7c80a..95d2a749a 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/AccountsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/AccountsAPI.md @@ -42,21 +42,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-account**](#create-account) | **Post** `/accounts` | Create Account -[**delete-account**](#delete-account) | **Delete** `/accounts/{id}` | Delete Account -[**disable-account**](#disable-account) | **Post** `/accounts/{id}/disable` | Disable Account -[**enable-account**](#enable-account) | **Post** `/accounts/{id}/enable` | Enable Account -[**get-account**](#get-account) | **Get** `/accounts/{id}` | Account Details -[**get-account-entitlements**](#get-account-entitlements) | **Get** `/accounts/{id}/entitlements` | Account Entitlements -[**list-accounts**](#list-accounts) | **Get** `/accounts` | Accounts List -[**put-account**](#put-account) | **Put** `/accounts/{id}` | Update Account -[**submit-reload-account**](#submit-reload-account) | **Post** `/accounts/{id}/reload` | Reload Account -[**unlock-account**](#unlock-account) | **Post** `/accounts/{id}/unlock` | Unlock Account -[**update-account**](#update-account) | **Patch** `/accounts/{id}` | Update Account +[**create-account**](#create-account) | **Post** `/accounts` | Create account +[**delete-account**](#delete-account) | **Delete** `/accounts/{id}` | Delete account +[**disable-account**](#disable-account) | **Post** `/accounts/{id}/disable` | Disable account +[**enable-account**](#enable-account) | **Post** `/accounts/{id}/enable` | Enable account +[**get-account**](#get-account) | **Get** `/accounts/{id}` | Account details +[**get-account-entitlements**](#get-account-entitlements) | **Get** `/accounts/{id}/entitlements` | Account entitlements +[**list-accounts**](#list-accounts) | **Get** `/accounts` | Accounts list +[**put-account**](#put-account) | **Put** `/accounts/{id}` | Update account +[**submit-reload-account**](#submit-reload-account) | **Post** `/accounts/{id}/reload` | Reload account +[**unlock-account**](#unlock-account) | **Post** `/accounts/{id}/unlock` | Unlock account +[**update-account**](#update-account) | **Patch** `/accounts/{id}` | Update account ## create-account -Create Account +Create account Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. @@ -143,7 +143,7 @@ func main() { [[Back to top]](#) ## delete-account -Delete Account +Delete account Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. @@ -212,7 +212,7 @@ func main() { [[Back to top]](#) ## disable-account -Disable Account +Disable account This API submits a task to disable the account and returns the task ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/disable-account) @@ -288,7 +288,7 @@ func main() { [[Back to top]](#) ## enable-account -Enable Account +Enable account This API submits a task to enable account and returns the task ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/enable-account) @@ -364,7 +364,7 @@ func main() { [[Back to top]](#) ## get-account -Account Details +Account details Use this API to return the details for a single account by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-account) @@ -430,7 +430,7 @@ func main() { [[Back to top]](#) ## get-account-entitlements -Account Entitlements +Account entitlements This API returns entitlements of the account. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-account-entitlements) @@ -502,7 +502,7 @@ func main() { [[Back to top]](#) ## list-accounts -Accounts List +Accounts list List accounts. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-accounts) @@ -574,7 +574,7 @@ func main() { [[Back to top]](#) ## put-account -Update Account +Update account Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. @@ -660,7 +660,7 @@ func main() { [[Back to top]](#) ## submit-reload-account -Reload Account +Reload account This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. [API Spec](https://developer.sailpoint.com/docs/api/v3/submit-reload-account) @@ -726,7 +726,7 @@ func main() { [[Back to top]](#) ## unlock-account -Unlock Account +Unlock account This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. @@ -804,7 +804,7 @@ func main() { [[Back to top]](#) ## update-account -Update Account +Update account Use this API to update account details. This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ApplicationDiscoveryAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ApplicationDiscoveryAPI.md index 18894881e..9d349018c 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/ApplicationDiscoveryAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/ApplicationDiscoveryAPI.md @@ -17,13 +17,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-discovered-applications**](#get-discovered-applications) | **Get** `/discovered-applications` | Get Discovered Applications for Tenant -[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **Get** `/manual-discover-applications-template` | Download CSV Template for Discovery -[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **Post** `/manual-discover-applications` | Upload CSV to Discover Applications +[**get-discovered-applications**](#get-discovered-applications) | **Get** `/discovered-applications` | Get discovered applications for tenant +[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **Get** `/manual-discover-applications-template` | Download csv template for discovery +[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **Post** `/manual-discover-applications` | Upload csv to discover applications ## get-discovered-applications -Get Discovered Applications for Tenant +Get discovered applications for tenant Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. @@ -94,7 +94,7 @@ func main() { [[Back to top]](#) ## get-manual-discover-applications-csv-template -Download CSV Template for Discovery +Download csv template for discovery Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. @@ -154,7 +154,7 @@ func main() { [[Back to top]](#) ## send-manual-discover-applications-csv-template -Upload CSV to Discover Applications +Upload csv to discover applications Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. diff --git a/docs/tools/sdk/go/Reference/V3/Methods/AuthUsersAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/AuthUsersAPI.md index 51420a167..91a114167 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/AuthUsersAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/AuthUsersAPI.md @@ -20,12 +20,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-auth-user**](#get-auth-user) | **Get** `/auth-users/{id}` | Auth User Details -[**patch-auth-user**](#patch-auth-user) | **Patch** `/auth-users/{id}` | Auth User Update +[**get-auth-user**](#get-auth-user) | **Get** `/auth-users/{id}` | Auth user details +[**patch-auth-user**](#patch-auth-user) | **Patch** `/auth-users/{id}` | Auth user update ## get-auth-user -Auth User Details +Auth user details Return the specified user's authentication system details. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-user) @@ -91,7 +91,7 @@ func main() { [[Back to top]](#) ## patch-auth-user -Auth User Update +Auth user update Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` diff --git a/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignFiltersAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignFiltersAPI.md index 615c422ca..bc5144a08 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignFiltersAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignFiltersAPI.md @@ -42,15 +42,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-campaign-filter**](#create-campaign-filter) | **Post** `/campaign-filters` | Create Campaign Filter -[**delete-campaign-filters**](#delete-campaign-filters) | **Post** `/campaign-filters/delete` | Deletes Campaign Filters -[**get-campaign-filter-by-id**](#get-campaign-filter-by-id) | **Get** `/campaign-filters/{id}` | Get Campaign Filter by ID -[**list-campaign-filters**](#list-campaign-filters) | **Get** `/campaign-filters` | List Campaign Filters -[**update-campaign-filter**](#update-campaign-filter) | **Post** `/campaign-filters/{id}` | Updates a Campaign Filter +[**create-campaign-filter**](#create-campaign-filter) | **Post** `/campaign-filters` | Create campaign filter +[**delete-campaign-filters**](#delete-campaign-filters) | **Post** `/campaign-filters/delete` | Deletes campaign filters +[**get-campaign-filter-by-id**](#get-campaign-filter-by-id) | **Get** `/campaign-filters/{id}` | Get campaign filter by id +[**list-campaign-filters**](#list-campaign-filters) | **Get** `/campaign-filters` | List campaign filters +[**update-campaign-filter**](#update-campaign-filter) | **Post** `/campaign-filters/{id}` | Updates a campaign filter ## create-campaign-filter -Create Campaign Filter +Create campaign filter Use this API to create a campaign filter based on filter details and criteria. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign-filter) @@ -134,7 +134,7 @@ func main() { [[Back to top]](#) ## delete-campaign-filters -Deletes Campaign Filters +Deletes campaign filters Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-filters) @@ -200,7 +200,7 @@ func main() { [[Back to top]](#) ## get-campaign-filter-by-id -Get Campaign Filter by ID +Get campaign filter by id Retrieves information for an existing campaign filter using the filter's ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-filter-by-id) @@ -266,7 +266,7 @@ func main() { [[Back to top]](#) ## list-campaign-filters -List Campaign Filters +List campaign filters Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-campaign-filters) @@ -332,7 +332,7 @@ func main() { [[Back to top]](#) ## update-campaign-filter -Updates a Campaign Filter +Updates a campaign filter Updates an existing campaign filter using the filter's ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/update-campaign-filter) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignsAPI.md index c1cdf2358..69bea6e25 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignsAPI.md @@ -80,32 +80,32 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**complete-campaign**](#complete-campaign) | **Post** `/campaigns/{id}/complete` | Complete a Campaign +[**complete-campaign**](#complete-campaign) | **Post** `/campaigns/{id}/complete` | Complete a campaign [**create-campaign**](#create-campaign) | **Post** `/campaigns` | Create a campaign -[**create-campaign-template**](#create-campaign-template) | **Post** `/campaign-templates` | Create a Campaign Template -[**delete-campaign-template**](#delete-campaign-template) | **Delete** `/campaign-templates/{id}` | Delete a Campaign Template -[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **Delete** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule -[**delete-campaigns**](#delete-campaigns) | **Post** `/campaigns/delete` | Delete Campaigns -[**get-active-campaigns**](#get-active-campaigns) | **Get** `/campaigns` | List Campaigns -[**get-campaign**](#get-campaign) | **Get** `/campaigns/{id}` | Get Campaign -[**get-campaign-reports**](#get-campaign-reports) | **Get** `/campaigns/{id}/reports` | Get Campaign Reports -[**get-campaign-reports-config**](#get-campaign-reports-config) | **Get** `/campaigns/reports-configuration` | Get Campaign Reports Configuration -[**get-campaign-template**](#get-campaign-template) | **Get** `/campaign-templates/{id}` | Get a Campaign Template -[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **Get** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule -[**get-campaign-templates**](#get-campaign-templates) | **Get** `/campaign-templates` | List Campaign Templates -[**move**](#move) | **Post** `/campaigns/{id}/reassign` | Reassign Certifications -[**patch-campaign-template**](#patch-campaign-template) | **Patch** `/campaign-templates/{id}` | Update a Campaign Template -[**set-campaign-reports-config**](#set-campaign-reports-config) | **Put** `/campaigns/reports-configuration` | Set Campaign Reports Configuration -[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **Put** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule -[**start-campaign**](#start-campaign) | **Post** `/campaigns/{id}/activate` | Activate a Campaign -[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **Post** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan -[**start-campaign-report**](#start-campaign-report) | **Post** `/campaigns/{id}/run-report/{type}` | Run Campaign Report -[**start-generate-campaign-template**](#start-generate-campaign-template) | **Post** `/campaign-templates/{id}/generate` | Generate a Campaign from Template -[**update-campaign**](#update-campaign) | **Patch** `/campaigns/{id}` | Update a Campaign +[**create-campaign-template**](#create-campaign-template) | **Post** `/campaign-templates` | Create a campaign template +[**delete-campaign-template**](#delete-campaign-template) | **Delete** `/campaign-templates/{id}` | Delete a campaign template +[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **Delete** `/campaign-templates/{id}/schedule` | Delete campaign template schedule +[**delete-campaigns**](#delete-campaigns) | **Post** `/campaigns/delete` | Delete campaigns +[**get-active-campaigns**](#get-active-campaigns) | **Get** `/campaigns` | List campaigns +[**get-campaign**](#get-campaign) | **Get** `/campaigns/{id}` | Get campaign +[**get-campaign-reports**](#get-campaign-reports) | **Get** `/campaigns/{id}/reports` | Get campaign reports +[**get-campaign-reports-config**](#get-campaign-reports-config) | **Get** `/campaigns/reports-configuration` | Get campaign reports configuration +[**get-campaign-template**](#get-campaign-template) | **Get** `/campaign-templates/{id}` | Get a campaign template +[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **Get** `/campaign-templates/{id}/schedule` | Get campaign template schedule +[**get-campaign-templates**](#get-campaign-templates) | **Get** `/campaign-templates` | List campaign templates +[**move**](#move) | **Post** `/campaigns/{id}/reassign` | Reassign certifications +[**patch-campaign-template**](#patch-campaign-template) | **Patch** `/campaign-templates/{id}` | Update a campaign template +[**set-campaign-reports-config**](#set-campaign-reports-config) | **Put** `/campaigns/reports-configuration` | Set campaign reports configuration +[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **Put** `/campaign-templates/{id}/schedule` | Set campaign template schedule +[**start-campaign**](#start-campaign) | **Post** `/campaigns/{id}/activate` | Activate a campaign +[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **Post** `/campaigns/{id}/run-remediation-scan` | Run campaign remediation scan +[**start-campaign-report**](#start-campaign-report) | **Post** `/campaigns/{id}/run-report/{type}` | Run campaign report +[**start-generate-campaign-template**](#start-generate-campaign-template) | **Post** `/campaign-templates/{id}/generate` | Generate a campaign from template +[**update-campaign**](#update-campaign) | **Patch** `/campaigns/{id}` | Update a campaign ## complete-campaign -Complete a Campaign +Complete a campaign :::caution This endpoint will run successfully for any campaigns that are **past due**. @@ -361,7 +361,7 @@ func main() { [[Back to top]](#) ## create-campaign-template -Create a Campaign Template +Create a campaign template Use this API to create a certification campaign template based on campaign. @@ -553,7 +553,7 @@ func main() { [[Back to top]](#) ## delete-campaign-template -Delete a Campaign Template +Delete a campaign template Use this API to delete a certification campaign template by ID. @@ -619,7 +619,7 @@ func main() { [[Back to top]](#) ## delete-campaign-template-schedule -Delete Campaign Template Schedule +Delete campaign template schedule Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. @@ -685,7 +685,7 @@ func main() { [[Back to top]](#) ## delete-campaigns -Delete Campaigns +Delete campaigns Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. @@ -755,7 +755,7 @@ func main() { [[Back to top]](#) ## get-active-campaigns -List Campaigns +List campaigns Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. @@ -828,7 +828,7 @@ func main() { [[Back to top]](#) ## get-campaign -Get Campaign +Get campaign Use this API to get information for an existing certification campaign by the campaign's ID. @@ -897,7 +897,7 @@ func main() { [[Back to top]](#) ## get-campaign-reports -Get Campaign Reports +Get campaign reports Use this API to fetch all reports for a certification campaign by campaign ID. @@ -964,7 +964,7 @@ func main() { [[Back to top]](#) ## get-campaign-reports-config -Get Campaign Reports Configuration +Get campaign reports configuration Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. @@ -1022,7 +1022,7 @@ func main() { [[Back to top]](#) ## get-campaign-template -Get a Campaign Template +Get a campaign template Use this API to fetch a certification campaign template by ID. @@ -1089,7 +1089,7 @@ func main() { [[Back to top]](#) ## get-campaign-template-schedule -Get Campaign Template Schedule +Get campaign template schedule Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. @@ -1156,7 +1156,7 @@ func main() { [[Back to top]](#) ## get-campaign-templates -List Campaign Templates +List campaign templates Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. @@ -1229,7 +1229,7 @@ func main() { [[Back to top]](#) ## move -Reassign Certifications +Reassign certifications This API reassigns the specified certifications from one identity to another. @@ -1310,7 +1310,7 @@ func main() { [[Back to top]](#) ## patch-campaign-template -Update a Campaign Template +Update a campaign template Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. @@ -1384,7 +1384,7 @@ func main() { [[Back to top]](#) ## set-campaign-reports-config -Set Campaign Reports Configuration +Set campaign reports configuration Use this API to overwrite the configuration for campaign reports. @@ -1454,7 +1454,7 @@ func main() { [[Back to top]](#) ## set-campaign-template-schedule -Set Campaign Template Schedule +Set campaign template schedule Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. @@ -1541,7 +1541,7 @@ func main() { [[Back to top]](#) ## start-campaign -Activate a Campaign +Activate a campaign Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. @@ -1612,7 +1612,7 @@ func main() { [[Back to top]](#) ## start-campaign-remediation-scan -Run Campaign Remediation Scan +Run campaign remediation scan Use this API to run a remediation scan task for a certification campaign. @@ -1679,7 +1679,7 @@ func main() { [[Back to top]](#) ## start-campaign-report -Run Campaign Report +Run campaign report Use this API to run a report for a certification campaign. @@ -1749,7 +1749,7 @@ func main() { [[Back to top]](#) ## start-generate-campaign-template -Generate a Campaign from Template +Generate a campaign from template Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description @@ -1826,7 +1826,7 @@ func main() { [[Back to top]](#) ## update-campaign -Update a Campaign +Update a campaign Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. diff --git a/docs/tools/sdk/go/Reference/V3/Methods/CertificationSummariesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/CertificationSummariesAPI.md index 2b67e9461..7f3dd5232 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/CertificationSummariesAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/CertificationSummariesAPI.md @@ -29,14 +29,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-identity-access-summaries**](#get-identity-access-summaries) | **Get** `/certifications/{id}/access-summaries/{type}` | Access Summaries -[**get-identity-decision-summary**](#get-identity-decision-summary) | **Get** `/certifications/{id}/decision-summary` | Summary of Certification Decisions -[**get-identity-summaries**](#get-identity-summaries) | **Get** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification -[**get-identity-summary**](#get-identity-summary) | **Get** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity +[**get-identity-access-summaries**](#get-identity-access-summaries) | **Get** `/certifications/{id}/access-summaries/{type}` | Access summaries +[**get-identity-decision-summary**](#get-identity-decision-summary) | **Get** `/certifications/{id}/decision-summary` | Summary of certification decisions +[**get-identity-summaries**](#get-identity-summaries) | **Get** `/certifications/{id}/identity-summaries` | Identity summaries for campaign certification +[**get-identity-summary**](#get-identity-summary) | **Get** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for identity ## get-identity-access-summaries -Access Summaries +Access summaries This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-access-summaries) @@ -115,7 +115,7 @@ func main() { [[Back to top]](#) ## get-identity-decision-summary -Summary of Certification Decisions +Summary of certification decisions This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-decision-summary) @@ -183,7 +183,7 @@ func main() { [[Back to top]](#) ## get-identity-summaries -Identity Summaries for Campaign Certification +Identity summaries for campaign certification This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-summaries) @@ -259,7 +259,7 @@ func main() { [[Back to top]](#) ## get-identity-summary -Summary for Identity +Summary for identity This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-summary) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/CertificationsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/CertificationsAPI.md index 51a16b85c..7209bd90e 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/CertificationsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/CertificationsAPI.md @@ -38,21 +38,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-certification-task**](#get-certification-task) | **Get** `/certification-tasks/{id}` | Certification Task by ID -[**get-identity-certification**](#get-identity-certification) | **Get** `/certifications/{id}` | Identity Certification by ID -[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **Get** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item -[**get-pending-certification-tasks**](#get-pending-certification-tasks) | **Get** `/certification-tasks` | List of Pending Certification Tasks -[**list-certification-reviewers**](#list-certification-reviewers) | **Get** `/certifications/{id}/reviewers` | List of Reviewers for certification -[**list-identity-access-review-items**](#list-identity-access-review-items) | **Get** `/certifications/{id}/access-review-items` | List of Access Review Items -[**list-identity-certifications**](#list-identity-certifications) | **Get** `/certifications` | List Identity Campaign Certifications -[**make-identity-decision**](#make-identity-decision) | **Post** `/certifications/{id}/decide` | Decide on a Certification Item -[**reassign-identity-certifications**](#reassign-identity-certifications) | **Post** `/certifications/{id}/reassign` | Reassign Identities or Items -[**sign-off-identity-certification**](#sign-off-identity-certification) | **Post** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions -[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **Post** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously +[**get-certification-task**](#get-certification-task) | **Get** `/certification-tasks/{id}` | Certification task by id +[**get-identity-certification**](#get-identity-certification) | **Get** `/certifications/{id}` | Identity certification by id +[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **Get** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for entitlement certification item +[**get-pending-certification-tasks**](#get-pending-certification-tasks) | **Get** `/certification-tasks` | List of pending certification tasks +[**list-certification-reviewers**](#list-certification-reviewers) | **Get** `/certifications/{id}/reviewers` | List of reviewers for certification +[**list-identity-access-review-items**](#list-identity-access-review-items) | **Get** `/certifications/{id}/access-review-items` | List of access review items +[**list-identity-certifications**](#list-identity-certifications) | **Get** `/certifications` | List identity campaign certifications +[**make-identity-decision**](#make-identity-decision) | **Post** `/certifications/{id}/decide` | Decide on a certification item +[**reassign-identity-certifications**](#reassign-identity-certifications) | **Post** `/certifications/{id}/reassign` | Reassign identities or items +[**sign-off-identity-certification**](#sign-off-identity-certification) | **Post** `/certifications/{id}/sign-off` | Finalize identity certification decisions +[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **Post** `/certifications/{id}/reassign-async` | Reassign certifications asynchronously ## get-certification-task -Certification Task by ID +Certification task by id This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-certification-task) @@ -118,7 +118,7 @@ func main() { [[Back to top]](#) ## get-identity-certification -Identity Certification by ID +Identity certification by id This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-certification) @@ -184,7 +184,7 @@ func main() { [[Back to top]](#) ## get-identity-certification-item-permissions -Permissions for Entitlement Certification Item +Permissions for entitlement certification item This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-certification-item-permissions) @@ -261,7 +261,7 @@ func main() { [[Back to top]](#) ## get-pending-certification-tasks -List of Pending Certification Tasks +List of pending certification tasks This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-pending-certification-tasks) @@ -331,7 +331,7 @@ func main() { [[Back to top]](#) ## list-certification-reviewers -List of Reviewers for certification +List of reviewers for certification This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-certification-reviewers) @@ -407,7 +407,7 @@ func main() { [[Back to top]](#) ## list-identity-access-review-items -List of Access Review Items +List of access review items This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-access-review-items) @@ -489,7 +489,7 @@ func main() { [[Back to top]](#) ## list-identity-certifications -List Identity Campaign Certifications +List identity campaign certifications Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-certifications) @@ -561,7 +561,7 @@ func main() { [[Back to top]](#) ## make-identity-decision -Decide on a Certification Item +Decide on a certification item The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v3/make-identity-decision) @@ -634,7 +634,7 @@ func main() { [[Back to top]](#) ## reassign-identity-certifications -Reassign Identities or Items +Reassign identities or items This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v3/reassign-identity-certifications) @@ -717,7 +717,7 @@ func main() { [[Back to top]](#) ## sign-off-identity-certification -Finalize Identity Certification Decisions +Finalize identity certification decisions This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. [API Spec](https://developer.sailpoint.com/docs/api/v3/sign-off-identity-certification) @@ -783,7 +783,7 @@ func main() { [[Back to top]](#) ## submit-reassign-certs-async -Reassign Certifications Asynchronously +Reassign certifications asynchronously This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ConfigurationHubAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ConfigurationHubAPI.md index 66da4466e..eedac4a07 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/ConfigurationHubAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/ConfigurationHubAPI.md @@ -26,12 +26,12 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create-object-mapping**](#create-object-mapping) | **Post** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping [**create-object-mappings**](#create-object-mappings) | **Post** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings -[**create-uploaded-configuration**](#create-uploaded-configuration) | **Post** `/configuration-hub/backups/uploads` | Upload a Configuration +[**create-uploaded-configuration**](#create-uploaded-configuration) | **Post** `/configuration-hub/backups/uploads` | Upload a configuration [**delete-object-mapping**](#delete-object-mapping) | **Delete** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping -[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **Delete** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration +[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **Delete** `/configuration-hub/backups/uploads/{id}` | Delete an uploaded configuration [**get-object-mappings**](#get-object-mappings) | **Get** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings -[**get-uploaded-configuration**](#get-uploaded-configuration) | **Get** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration -[**list-uploaded-configurations**](#list-uploaded-configurations) | **Get** `/configuration-hub/backups/uploads` | List Uploaded Configurations +[**get-uploaded-configuration**](#get-uploaded-configuration) | **Get** `/configuration-hub/backups/uploads/{id}` | Get an uploaded configuration +[**list-uploaded-configurations**](#list-uploaded-configurations) | **Get** `/configuration-hub/backups/uploads` | List uploaded configurations [**update-object-mappings**](#update-object-mappings) | **Post** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings @@ -208,7 +208,7 @@ func main() { [[Back to top]](#) ## create-uploaded-configuration -Upload a Configuration +Upload a configuration This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. @@ -347,7 +347,7 @@ func main() { [[Back to top]](#) ## delete-uploaded-configuration -Delete an Uploaded Configuration +Delete an uploaded configuration This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. @@ -485,7 +485,7 @@ func main() { [[Back to top]](#) ## get-uploaded-configuration -Get an Uploaded Configuration +Get an uploaded configuration This API gets an existing uploaded configuration for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-uploaded-configuration) @@ -551,7 +551,7 @@ func main() { [[Back to top]](#) ## list-uploaded-configurations -List Uploaded Configurations +List uploaded configurations This API gets a list of existing uploaded configurations for the current tenant. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-uploaded-configurations) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ConnectorsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ConnectorsAPI.md index 29066c7e9..7be73f261 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/ConnectorsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/ConnectorsAPI.md @@ -29,21 +29,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-custom-connector**](#create-custom-connector) | **Post** `/connectors` | Create Custom Connector -[**delete-custom-connector**](#delete-custom-connector) | **Delete** `/connectors/{scriptName}` | Delete Connector by Script Name -[**get-connector**](#get-connector) | **Get** `/connectors/{scriptName}` | Get Connector by Script Name -[**get-connector-list**](#get-connector-list) | **Get** `/connectors` | Get Connector List -[**get-connector-source-config**](#get-connector-source-config) | **Get** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration -[**get-connector-source-template**](#get-connector-source-template) | **Get** `/connectors/{scriptName}/source-template` | Get Connector Source Template -[**get-connector-translations**](#get-connector-translations) | **Get** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations -[**put-connector-source-config**](#put-connector-source-config) | **Put** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration -[**put-connector-source-template**](#put-connector-source-template) | **Put** `/connectors/{scriptName}/source-template` | Update Connector Source Template -[**put-connector-translations**](#put-connector-translations) | **Put** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations -[**update-connector**](#update-connector) | **Patch** `/connectors/{scriptName}` | Update Connector by Script Name +[**create-custom-connector**](#create-custom-connector) | **Post** `/connectors` | Create custom connector +[**delete-custom-connector**](#delete-custom-connector) | **Delete** `/connectors/{scriptName}` | Delete connector by script name +[**get-connector**](#get-connector) | **Get** `/connectors/{scriptName}` | Get connector by script name +[**get-connector-list**](#get-connector-list) | **Get** `/connectors` | Get connector list +[**get-connector-source-config**](#get-connector-source-config) | **Get** `/connectors/{scriptName}/source-config` | Get connector source configuration +[**get-connector-source-template**](#get-connector-source-template) | **Get** `/connectors/{scriptName}/source-template` | Get connector source template +[**get-connector-translations**](#get-connector-translations) | **Get** `/connectors/{scriptName}/translations/{locale}` | Get connector translations +[**put-connector-source-config**](#put-connector-source-config) | **Put** `/connectors/{scriptName}/source-config` | Update connector source configuration +[**put-connector-source-template**](#put-connector-source-template) | **Put** `/connectors/{scriptName}/source-template` | Update connector source template +[**put-connector-translations**](#put-connector-translations) | **Put** `/connectors/{scriptName}/translations/{locale}` | Update connector translations +[**update-connector**](#update-connector) | **Patch** `/connectors/{scriptName}` | Update connector by script name ## create-custom-connector -Create Custom Connector +Create custom connector Create custom connector. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-custom-connector) @@ -116,7 +116,7 @@ func main() { [[Back to top]](#) ## delete-custom-connector -Delete Connector by Script Name +Delete connector by script name Delete a custom connector that using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-custom-connector) @@ -181,7 +181,7 @@ func main() { [[Back to top]](#) ## get-connector -Get Connector by Script Name +Get connector by script name Fetches a connector that using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector) @@ -249,7 +249,7 @@ func main() { [[Back to top]](#) ## get-connector-list -Get Connector List +Get connector list Fetches list of connectors that have 'RELEASED' status using filtering and pagination. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-list) @@ -319,7 +319,7 @@ func main() { [[Back to top]](#) ## get-connector-source-config -Get Connector Source Configuration +Get connector source configuration Fetches a connector's source config using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-source-config) @@ -385,7 +385,7 @@ func main() { [[Back to top]](#) ## get-connector-source-template -Get Connector Source Template +Get connector source template Fetches a connector's source template using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-source-template) @@ -451,7 +451,7 @@ func main() { [[Back to top]](#) ## get-connector-translations -Get Connector Translations +Get connector translations Fetches a connector's translations using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-translations) @@ -520,7 +520,7 @@ func main() { [[Back to top]](#) ## put-connector-source-config -Update Connector Source Configuration +Update connector source configuration Update a connector's source config using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-source-config) @@ -588,7 +588,7 @@ func main() { [[Back to top]](#) ## put-connector-source-template -Update Connector Source Template +Update connector source template Update a connector's source template using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-source-template) @@ -656,7 +656,7 @@ func main() { [[Back to top]](#) ## put-connector-translations -Update Connector Translations +Update connector translations Update a connector's translations using its script name. [API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-translations) @@ -725,7 +725,7 @@ func main() { [[Back to top]](#) ## update-connector -Update Connector by Script Name +Update connector by script name This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: diff --git a/docs/tools/sdk/go/Reference/V3/Methods/GlobalTenantSecuritySettingsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/GlobalTenantSecuritySettingsAPI.md index e571af52b..118dfb9fb 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/GlobalTenantSecuritySettingsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/GlobalTenantSecuritySettingsAPI.md @@ -19,14 +19,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-auth-org-network-config**](#create-auth-org-network-config) | **Post** `/auth-org/network-config` | Create security network configuration. -[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **Get** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. +[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **Get** `/auth-org/lockout-config` | Get auth org lockout configuration. [**get-auth-org-network-config**](#get-auth-org-network-config) | **Get** `/auth-org/network-config` | Get security network configuration. -[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **Get** `/auth-org/service-provider-config` | Get Service Provider Configuration. -[**get-auth-org-session-config**](#get-auth-org-session-config) | **Get** `/auth-org/session-config` | Get Auth Org Session Configuration. -[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **Patch** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration +[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **Get** `/auth-org/service-provider-config` | Get service provider configuration. +[**get-auth-org-session-config**](#get-auth-org-session-config) | **Get** `/auth-org/session-config` | Get auth org session configuration. +[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **Patch** `/auth-org/lockout-config` | Update auth org lockout configuration [**patch-auth-org-network-config**](#patch-auth-org-network-config) | **Patch** `/auth-org/network-config` | Update security network configuration. -[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **Patch** `/auth-org/service-provider-config` | Update Service Provider Configuration -[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **Patch** `/auth-org/session-config` | Update Auth Org Session Configuration +[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **Patch** `/auth-org/service-provider-config` | Update service provider configuration +[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **Patch** `/auth-org/session-config` | Update auth org session configuration ## create-auth-org-network-config @@ -101,7 +101,7 @@ func main() { [[Back to top]](#) ## get-auth-org-lockout-config -Get Auth Org Lockout Configuration. +Get auth org lockout configuration. This API returns the details of an org's lockout auth configuration. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-lockout-config) @@ -215,7 +215,7 @@ func main() { [[Back to top]](#) ## get-auth-org-service-provider-config -Get Service Provider Configuration. +Get service provider configuration. This API returns the details of an org's service provider auth configuration. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-service-provider-config) @@ -272,7 +272,7 @@ func main() { [[Back to top]](#) ## get-auth-org-session-config -Get Auth Org Session Configuration. +Get auth org session configuration. This API returns the details of an org's session auth configuration. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-session-config) @@ -329,7 +329,7 @@ func main() { [[Back to top]](#) ## patch-auth-org-lockout-config -Update Auth Org Lockout Configuration +Update auth org lockout configuration This API updates an existing lockout configuration for an org using PATCH @@ -465,7 +465,7 @@ func main() { [[Back to top]](#) ## patch-auth-org-service-provider-config -Update Service Provider Configuration +Update service provider configuration This API updates an existing service provider configuration for an org using PATCH. [API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-service-provider-config) @@ -532,7 +532,7 @@ func main() { [[Back to top]](#) ## patch-auth-org-session-config -Update Auth Org Session Configuration +Update auth org session configuration This API updates an existing session configuration for an org using PATCH. [API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-session-config) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/IdentityProfilesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/IdentityProfilesAPI.md index 39d8aeb5a..8b46b8a6e 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/IdentityProfilesAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/IdentityProfilesAPI.md @@ -25,21 +25,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-identity-profile**](#create-identity-profile) | **Post** `/identity-profiles` | Create Identity Profile -[**delete-identity-profile**](#delete-identity-profile) | **Delete** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile -[**delete-identity-profiles**](#delete-identity-profiles) | **Post** `/identity-profiles/bulk-delete` | Delete Identity Profiles -[**export-identity-profiles**](#export-identity-profiles) | **Get** `/identity-profiles/export` | Export Identity Profiles -[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **Get** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config -[**get-identity-profile**](#get-identity-profile) | **Get** `/identity-profiles/{identity-profile-id}` | Get Identity Profile -[**import-identity-profiles**](#import-identity-profiles) | **Post** `/identity-profiles/import` | Import Identity Profiles -[**list-identity-profiles**](#list-identity-profiles) | **Get** `/identity-profiles` | List Identity Profiles -[**show-identity-preview**](#show-identity-preview) | **Post** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**create-identity-profile**](#create-identity-profile) | **Post** `/identity-profiles` | Create identity profile +[**delete-identity-profile**](#delete-identity-profile) | **Delete** `/identity-profiles/{identity-profile-id}` | Delete identity profile +[**delete-identity-profiles**](#delete-identity-profiles) | **Post** `/identity-profiles/bulk-delete` | Delete identity profiles +[**export-identity-profiles**](#export-identity-profiles) | **Get** `/identity-profiles/export` | Export identity profiles +[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **Get** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default identity attribute config +[**get-identity-profile**](#get-identity-profile) | **Get** `/identity-profiles/{identity-profile-id}` | Get identity profile +[**import-identity-profiles**](#import-identity-profiles) | **Post** `/identity-profiles/import` | Import identity profiles +[**list-identity-profiles**](#list-identity-profiles) | **Get** `/identity-profiles` | List identity profiles +[**show-identity-preview**](#show-identity-preview) | **Post** `/identity-profiles/identity-preview` | Generate identity profile preview [**sync-identity-profile**](#sync-identity-profile) | **Post** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile -[**update-identity-profile**](#update-identity-profile) | **Patch** `/identity-profiles/{identity-profile-id}` | Update Identity Profile +[**update-identity-profile**](#update-identity-profile) | **Patch** `/identity-profiles/{identity-profile-id}` | Update identity profile ## create-identity-profile -Create Identity Profile +Create identity profile Creates an identity profile. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-identity-profile) @@ -154,7 +154,7 @@ func main() { [[Back to top]](#) ## delete-identity-profile -Delete Identity Profile +Delete identity profile Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. @@ -221,7 +221,7 @@ func main() { [[Back to top]](#) ## delete-identity-profiles -Delete Identity Profiles +Delete identity profiles This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. @@ -292,7 +292,7 @@ func main() { [[Back to top]](#) ## export-identity-profiles -Export Identity Profiles +Export identity profiles This exports existing identity profiles in the format specified by the sp-config service. [API Spec](https://developer.sailpoint.com/docs/api/v3/export-identity-profiles) @@ -362,7 +362,7 @@ func main() { [[Back to top]](#) ## get-default-identity-attribute-config -Get default Identity Attribute Config +Get default identity attribute config This returns the default identity attribute config. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-default-identity-attribute-config) @@ -428,7 +428,7 @@ func main() { [[Back to top]](#) ## get-identity-profile -Get Identity Profile +Get identity profile Get a single identity profile by ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-profile) @@ -494,7 +494,7 @@ func main() { [[Back to top]](#) ## import-identity-profiles -Import Identity Profiles +Import identity profiles This imports previously exported identity profiles. [API Spec](https://developer.sailpoint.com/docs/api/v3/import-identity-profiles) @@ -561,7 +561,7 @@ func main() { [[Back to top]](#) ## list-identity-profiles -List Identity Profiles +List identity profiles Get a list of identity profiles, based on the specified query parameters. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-profiles) @@ -631,7 +631,7 @@ func main() { [[Back to top]](#) ## show-identity-preview -Generate Identity Profile Preview +Generate identity profile preview Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. @@ -795,7 +795,7 @@ func main() { [[Back to top]](#) ## update-identity-profile -Update Identity Profile +Update identity profile Update a specified identity profile with this PATCH request. You cannot update these fields: diff --git a/docs/tools/sdk/go/Reference/V3/Methods/LifecycleStatesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/LifecycleStatesAPI.md index cd583dfa6..7f5506a8c 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/LifecycleStatesAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/LifecycleStatesAPI.md @@ -53,16 +53,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-lifecycle-state**](#create-lifecycle-state) | **Post** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State -[**delete-lifecycle-state**](#delete-lifecycle-state) | **Delete** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State -[**get-lifecycle-state**](#get-lifecycle-state) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State -[**get-lifecycle-states**](#get-lifecycle-states) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates -[**set-lifecycle-state**](#set-lifecycle-state) | **Post** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State -[**update-lifecycle-states**](#update-lifecycle-states) | **Patch** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State +[**create-lifecycle-state**](#create-lifecycle-state) | **Post** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create lifecycle state +[**delete-lifecycle-state**](#delete-lifecycle-state) | **Delete** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete lifecycle state +[**get-lifecycle-state**](#get-lifecycle-state) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get lifecycle state +[**get-lifecycle-states**](#get-lifecycle-states) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists lifecyclestates +[**set-lifecycle-state**](#set-lifecycle-state) | **Post** `/identities/{identity-id}/set-lifecycle-state` | Set lifecycle state +[**update-lifecycle-states**](#update-lifecycle-states) | **Patch** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update lifecycle state ## create-lifecycle-state -Create Lifecycle State +Create lifecycle state Use this endpoint to create a lifecycle state. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-lifecycle-state) @@ -159,7 +159,7 @@ func main() { [[Back to top]](#) ## delete-lifecycle-state -Delete Lifecycle State +Delete lifecycle state Use this endpoint to delete the lifecycle state by its ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-lifecycle-state) @@ -228,7 +228,7 @@ func main() { [[Back to top]](#) ## get-lifecycle-state -Get Lifecycle State +Get lifecycle state Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-lifecycle-state) @@ -297,7 +297,7 @@ func main() { [[Back to top]](#) ## get-lifecycle-states -Lists LifecycleStates +Lists lifecyclestates Use this endpoint to list all lifecycle states by their associated identity profiles. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-lifecycle-states) @@ -371,7 +371,7 @@ func main() { [[Back to top]](#) ## set-lifecycle-state -Set Lifecycle State +Set lifecycle state Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. [API Spec](https://developer.sailpoint.com/docs/api/v3/set-lifecycle-state) @@ -444,7 +444,7 @@ func main() { [[Back to top]](#) ## update-lifecycle-states -Update Lifecycle State +Update lifecycle state Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. [API Spec](https://developer.sailpoint.com/docs/api/v3/update-lifecycle-states) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/MFAConfigurationAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/MFAConfigurationAPI.md index df126d934..64526ede8 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/MFAConfigurationAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/MFAConfigurationAPI.md @@ -15,18 +15,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**delete-mfa-config**](#delete-mfa-config) | **Delete** `/mfa/{method}/delete` | Delete MFA method configuration -[**get-mfa-duo-config**](#get-mfa-duo-config) | **Get** `/mfa/duo-web/config` | Configuration of Duo MFA method -[**get-mfa-kba-config**](#get-mfa-kba-config) | **Get** `/mfa/kba/config` | Configuration of KBA MFA method -[**get-mfa-okta-config**](#get-mfa-okta-config) | **Get** `/mfa/okta-verify/config` | Configuration of Okta MFA method -[**set-mfa-duo-config**](#set-mfa-duo-config) | **Put** `/mfa/duo-web/config` | Set Duo MFA configuration -[**set-mfakba-config**](#set-mfakba-config) | **Post** `/mfa/kba/config/answers` | Set MFA KBA configuration -[**set-mfa-okta-config**](#set-mfa-okta-config) | **Put** `/mfa/okta-verify/config` | Set Okta MFA configuration -[**test-mfa-config**](#test-mfa-config) | **Get** `/mfa/{method}/test` | MFA method's test configuration +[**delete-mfa-config**](#delete-mfa-config) | **Delete** `/mfa/{method}/delete` | Delete mfa method configuration +[**get-mfa-duo-config**](#get-mfa-duo-config) | **Get** `/mfa/duo-web/config` | Configuration of duo mfa method +[**get-mfa-kba-config**](#get-mfa-kba-config) | **Get** `/mfa/kba/config` | Configuration of kba mfa method +[**get-mfa-okta-config**](#get-mfa-okta-config) | **Get** `/mfa/okta-verify/config` | Configuration of okta mfa method +[**set-mfa-duo-config**](#set-mfa-duo-config) | **Put** `/mfa/duo-web/config` | Set duo mfa configuration +[**set-mfakba-config**](#set-mfakba-config) | **Post** `/mfa/kba/config/answers` | Set mfa kba configuration +[**set-mfa-okta-config**](#set-mfa-okta-config) | **Put** `/mfa/okta-verify/config` | Set okta mfa configuration +[**test-mfa-config**](#test-mfa-config) | **Get** `/mfa/{method}/test` | Mfa method's test configuration ## delete-mfa-config -Delete MFA method configuration +Delete mfa method configuration This API removes the configuration for the specified MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-mfa-config) @@ -92,7 +92,7 @@ func main() { [[Back to top]](#) ## get-mfa-duo-config -Configuration of Duo MFA method +Configuration of duo mfa method This API returns the configuration of an Duo MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-duo-config) @@ -149,7 +149,7 @@ func main() { [[Back to top]](#) ## get-mfa-kba-config -Configuration of KBA MFA method +Configuration of kba mfa method This API returns the KBA configuration for MFA. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-kba-config) @@ -211,7 +211,7 @@ func main() { [[Back to top]](#) ## get-mfa-okta-config -Configuration of Okta MFA method +Configuration of okta mfa method This API returns the configuration of an Okta MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-okta-config) @@ -268,7 +268,7 @@ func main() { [[Back to top]](#) ## set-mfa-duo-config -Set Duo MFA configuration +Set duo mfa configuration This API sets the configuration of an Duo MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfa-duo-config) @@ -345,7 +345,7 @@ func main() { [[Back to top]](#) ## set-mfakba-config -Set MFA KBA configuration +Set mfa kba configuration This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. [API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfakba-config) @@ -412,7 +412,7 @@ func main() { [[Back to top]](#) ## set-mfa-okta-config -Set Okta MFA configuration +Set okta mfa configuration This API sets the configuration of an Okta MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfa-okta-config) @@ -485,7 +485,7 @@ func main() { [[Back to top]](#) ## test-mfa-config -MFA method's test configuration +Mfa method's test configuration This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. [API Spec](https://developer.sailpoint.com/docs/api/v3/test-mfa-config) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/MFAControllerAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/MFAControllerAPI.md index a7b0e350c..fc9f9d34f 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/MFAControllerAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/MFAControllerAPI.md @@ -16,11 +16,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-send-token**](#create-send-token) | **Post** `/mfa/token/send` | Create and send user token -[**ping-verification-status**](#ping-verification-status) | **Post** `/mfa/{method}/poll` | Polling MFA method by VerificationPollRequest -[**send-duo-verify-request**](#send-duo-verify-request) | **Post** `/mfa/duo-web/verify` | Verifying authentication via Duo method -[**send-kba-answers**](#send-kba-answers) | **Post** `/mfa/kba/authenticate` | Authenticate KBA provided MFA method -[**send-okta-verify-request**](#send-okta-verify-request) | **Post** `/mfa/okta-verify/verify` | Verifying authentication via Okta method -[**send-token-auth-request**](#send-token-auth-request) | **Post** `/mfa/token/authenticate` | Authenticate Token provided MFA method +[**ping-verification-status**](#ping-verification-status) | **Post** `/mfa/{method}/poll` | Polling mfa method by verificationpollrequest +[**send-duo-verify-request**](#send-duo-verify-request) | **Post** `/mfa/duo-web/verify` | Verifying authentication via duo method +[**send-kba-answers**](#send-kba-answers) | **Post** `/mfa/kba/authenticate` | Authenticate kba provided mfa method +[**send-okta-verify-request**](#send-okta-verify-request) | **Post** `/mfa/okta-verify/verify` | Verifying authentication via okta method +[**send-token-auth-request**](#send-token-auth-request) | **Post** `/mfa/token/authenticate` | Authenticate token provided mfa method ## create-send-token @@ -94,7 +94,7 @@ func main() { [[Back to top]](#) ## ping-verification-status -Polling MFA method by VerificationPollRequest +Polling mfa method by verificationpollrequest This API poll the VerificationPollRequest for the specified MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v3/ping-verification-status) @@ -169,7 +169,7 @@ func main() { [[Back to top]](#) ## send-duo-verify-request -Verifying authentication via Duo method +Verifying authentication via duo method This API Authenticates the user via Duo-Web MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v3/send-duo-verify-request) @@ -239,7 +239,7 @@ func main() { [[Back to top]](#) ## send-kba-answers -Authenticate KBA provided MFA method +Authenticate kba provided mfa method This API Authenticate user in KBA MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v3/send-kba-answers) @@ -306,7 +306,7 @@ func main() { [[Back to top]](#) ## send-okta-verify-request -Verifying authentication via Okta method +Verifying authentication via okta method This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller. [API Spec](https://developer.sailpoint.com/docs/api/v3/send-okta-verify-request) @@ -375,7 +375,7 @@ func main() { [[Back to top]](#) ## send-token-auth-request -Authenticate Token provided MFA method +Authenticate token provided mfa method This API Authenticate user in Token MFA method. [API Spec](https://developer.sailpoint.com/docs/api/v3/send-token-auth-request) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ManagedClientsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ManagedClientsAPI.md index 651d5538b..365681ab2 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/ManagedClientsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/ManagedClientsAPI.md @@ -17,16 +17,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-managed-client**](#create-managed-client) | **Post** `/managed-clients` | Create Managed Client -[**delete-managed-client**](#delete-managed-client) | **Delete** `/managed-clients/{id}` | Delete Managed Client -[**get-managed-client**](#get-managed-client) | **Get** `/managed-clients/{id}` | Get Managed Client -[**get-managed-client-status**](#get-managed-client-status) | **Get** `/managed-clients/{id}/status` | Get Managed Client Status -[**get-managed-clients**](#get-managed-clients) | **Get** `/managed-clients` | Get Managed Clients -[**update-managed-client**](#update-managed-client) | **Patch** `/managed-clients/{id}` | Update Managed Client +[**create-managed-client**](#create-managed-client) | **Post** `/managed-clients` | Create managed client +[**delete-managed-client**](#delete-managed-client) | **Delete** `/managed-clients/{id}` | Delete managed client +[**get-managed-client**](#get-managed-client) | **Get** `/managed-clients/{id}` | Get managed client +[**get-managed-client-status**](#get-managed-client-status) | **Get** `/managed-clients/{id}/status` | Get managed client status +[**get-managed-clients**](#get-managed-clients) | **Get** `/managed-clients` | Get managed clients +[**update-managed-client**](#update-managed-client) | **Patch** `/managed-clients/{id}` | Update managed client ## create-managed-client -Create Managed Client +Create managed client Create a new managed client. The API returns a result that includes the managed client ID. @@ -99,7 +99,7 @@ func main() { [[Back to top]](#) ## delete-managed-client -Delete Managed Client +Delete managed client Delete an existing managed client. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-managed-client) @@ -164,7 +164,7 @@ func main() { [[Back to top]](#) ## get-managed-client -Get Managed Client +Get managed client Get managed client by ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-client) @@ -230,7 +230,7 @@ func main() { [[Back to top]](#) ## get-managed-client-status -Get Managed Client Status +Get managed client status Get a managed client's status, using its ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-client-status) @@ -298,7 +298,7 @@ func main() { [[Back to top]](#) ## get-managed-clients -Get Managed Clients +Get managed clients List managed clients. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-clients) @@ -366,7 +366,7 @@ func main() { [[Back to top]](#) ## update-managed-client -Update Managed Client +Update managed client Update an existing managed client. [API Spec](https://developer.sailpoint.com/docs/api/v3/update-managed-client) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ManagedClustersAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ManagedClustersAPI.md index 103e77ee8..f0c44e7f2 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/ManagedClustersAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/ManagedClustersAPI.md @@ -17,17 +17,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-managed-cluster**](#create-managed-cluster) | **Post** `/managed-clusters` | Create Create Managed Cluster -[**delete-managed-cluster**](#delete-managed-cluster) | **Delete** `/managed-clusters/{id}` | Delete Managed Cluster -[**get-client-log-configuration**](#get-client-log-configuration) | **Get** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration -[**get-managed-cluster**](#get-managed-cluster) | **Get** `/managed-clusters/{id}` | Get Managed Cluster -[**get-managed-clusters**](#get-managed-clusters) | **Get** `/managed-clusters` | Get Managed Clusters -[**put-client-log-configuration**](#put-client-log-configuration) | **Put** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration -[**update-managed-cluster**](#update-managed-cluster) | **Patch** `/managed-clusters/{id}` | Update Managed Cluster +[**create-managed-cluster**](#create-managed-cluster) | **Post** `/managed-clusters` | Create create managed cluster +[**delete-managed-cluster**](#delete-managed-cluster) | **Delete** `/managed-clusters/{id}` | Delete managed cluster +[**get-client-log-configuration**](#get-client-log-configuration) | **Get** `/managed-clusters/{id}/log-config` | Get managed cluster log configuration +[**get-managed-cluster**](#get-managed-cluster) | **Get** `/managed-clusters/{id}` | Get managed cluster +[**get-managed-clusters**](#get-managed-clusters) | **Get** `/managed-clusters` | Get managed clusters +[**put-client-log-configuration**](#put-client-log-configuration) | **Put** `/managed-clusters/{id}/log-config` | Update managed cluster log configuration +[**update-managed-cluster**](#update-managed-cluster) | **Patch** `/managed-clusters/{id}` | Update managed cluster ## create-managed-cluster -Create Create Managed Cluster +Create create managed cluster Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. @@ -103,7 +103,7 @@ func main() { [[Back to top]](#) ## delete-managed-cluster -Delete Managed Cluster +Delete managed cluster Delete an existing managed cluster. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-managed-cluster) @@ -170,7 +170,7 @@ func main() { [[Back to top]](#) ## get-client-log-configuration -Get Managed Cluster Log Configuration +Get managed cluster log configuration Get a managed cluster's log configuration. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-client-log-configuration) @@ -236,7 +236,7 @@ func main() { [[Back to top]](#) ## get-managed-cluster -Get Managed Cluster +Get managed cluster Get a managed cluster by ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-cluster) @@ -302,7 +302,7 @@ func main() { [[Back to top]](#) ## get-managed-clusters -Get Managed Clusters +Get managed clusters List current organization's managed clusters, based on request context. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-clusters) @@ -370,7 +370,7 @@ func main() { [[Back to top]](#) ## put-client-log-configuration -Update Managed Cluster Log Configuration +Update managed cluster log configuration Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. [API Spec](https://developer.sailpoint.com/docs/api/v3/put-client-log-configuration) @@ -443,7 +443,7 @@ func main() { [[Back to top]](#) ## update-managed-cluster -Update Managed Cluster +Update managed cluster Update an existing managed cluster. [API Spec](https://developer.sailpoint.com/docs/api/v3/update-managed-cluster) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/NonEmployeeLifecycleManagementAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/NonEmployeeLifecycleManagementAPI.md index cf45ad87f..d9a5a7c2d 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/NonEmployeeLifecycleManagementAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/NonEmployeeLifecycleManagementAPI.md @@ -46,42 +46,42 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-non-employee-request**](#approve-non-employee-request) | **Post** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request -[**create-non-employee-record**](#create-non-employee-record) | **Post** `/non-employee-records` | Create Non-Employee Record -[**create-non-employee-request**](#create-non-employee-request) | **Post** `/non-employee-requests` | Create Non-Employee Request -[**create-non-employee-source**](#create-non-employee-source) | **Post** `/non-employee-sources` | Create Non-Employee Source -[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **Post** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source -[**delete-non-employee-record**](#delete-non-employee-record) | **Delete** `/non-employee-records/{id}` | Delete Non-Employee Record -[**delete-non-employee-records-in-bulk**](#delete-non-employee-records-in-bulk) | **Post** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records -[**delete-non-employee-request**](#delete-non-employee-request) | **Delete** `/non-employee-requests/{id}` | Delete Non-Employee Request -[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source -[**delete-non-employee-source**](#delete-non-employee-source) | **Delete** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source -[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source -[**export-non-employee-records**](#export-non-employee-records) | **Get** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV -[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **Get** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**approve-non-employee-request**](#approve-non-employee-request) | **Post** `/non-employee-approvals/{id}/approve` | Approve a non-employee request +[**create-non-employee-record**](#create-non-employee-record) | **Post** `/non-employee-records` | Create non-employee record +[**create-non-employee-request**](#create-non-employee-request) | **Post** `/non-employee-requests` | Create non-employee request +[**create-non-employee-source**](#create-non-employee-source) | **Post** `/non-employee-sources` | Create non-employee source +[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **Post** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new schema attribute for non-employee source +[**delete-non-employee-record**](#delete-non-employee-record) | **Delete** `/non-employee-records/{id}` | Delete non-employee record +[**delete-non-employee-records-in-bulk**](#delete-non-employee-records-in-bulk) | **Post** `/non-employee-records/bulk-delete` | Delete multiple non-employee records +[**delete-non-employee-request**](#delete-non-employee-request) | **Delete** `/non-employee-requests/{id}` | Delete non-employee request +[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a schema attribute for non-employee source +[**delete-non-employee-source**](#delete-non-employee-source) | **Delete** `/non-employee-sources/{sourceId}` | Delete non-employee source +[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for non-employee source +[**export-non-employee-records**](#export-non-employee-records) | **Get** `/non-employee-sources/{id}/non-employees/download` | Exports non-employee records to csv +[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **Get** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports source schema template [**get-non-employee-approval**](#get-non-employee-approval) | **Get** `/non-employee-approvals/{id}` | Get a non-employee approval item detail -[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **Get** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests +[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **Get** `/non-employee-approvals/summary/{requested-for}` | Get summary of non-employee approval requests [**get-non-employee-bulk-upload-status**](#get-non-employee-bulk-upload-status) | **Get** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source -[**get-non-employee-record**](#get-non-employee-record) | **Get** `/non-employee-records/{id}` | Get a Non-Employee Record -[**get-non-employee-request**](#get-non-employee-request) | **Get** `/non-employee-requests/{id}` | Get a Non-Employee Request -[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **Get** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests -[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **Get** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source -[**get-non-employee-source**](#get-non-employee-source) | **Get** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source -[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **Get** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source -[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **Post** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records -[**list-non-employee-approvals**](#list-non-employee-approvals) | **Get** `/non-employee-approvals` | Get List of Non-Employee Approval Requests -[**list-non-employee-records**](#list-non-employee-records) | **Get** `/non-employee-records` | List Non-Employee Records -[**list-non-employee-requests**](#list-non-employee-requests) | **Get** `/non-employee-requests` | List Non-Employee Requests -[**list-non-employee-sources**](#list-non-employee-sources) | **Get** `/non-employee-sources` | List Non-Employee Sources -[**patch-non-employee-record**](#patch-non-employee-record) | **Patch** `/non-employee-records/{id}` | Patch Non-Employee Record -[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **Patch** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source -[**patch-non-employee-source**](#patch-non-employee-source) | **Patch** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source -[**reject-non-employee-request**](#reject-non-employee-request) | **Post** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request -[**update-non-employee-record**](#update-non-employee-record) | **Put** `/non-employee-records/{id}` | Update Non-Employee Record +[**get-non-employee-record**](#get-non-employee-record) | **Get** `/non-employee-records/{id}` | Get a non-employee record +[**get-non-employee-request**](#get-non-employee-request) | **Get** `/non-employee-requests/{id}` | Get a non-employee request +[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **Get** `/non-employee-requests/summary/{requested-for}` | Get summary of non-employee requests +[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **Get** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get schema attribute non-employee source +[**get-non-employee-source**](#get-non-employee-source) | **Get** `/non-employee-sources/{sourceId}` | Get a non-employee source +[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **Get** `/non-employee-sources/{sourceId}/schema-attributes` | List schema attributes non-employee source +[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **Post** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or updates, non-employee records +[**list-non-employee-approvals**](#list-non-employee-approvals) | **Get** `/non-employee-approvals` | Get list of non-employee approval requests +[**list-non-employee-records**](#list-non-employee-records) | **Get** `/non-employee-records` | List non-employee records +[**list-non-employee-requests**](#list-non-employee-requests) | **Get** `/non-employee-requests` | List non-employee requests +[**list-non-employee-sources**](#list-non-employee-sources) | **Get** `/non-employee-sources` | List non-employee sources +[**patch-non-employee-record**](#patch-non-employee-record) | **Patch** `/non-employee-records/{id}` | Patch non-employee record +[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **Patch** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a schema attribute for non-employee source +[**patch-non-employee-source**](#patch-non-employee-source) | **Patch** `/non-employee-sources/{sourceId}` | Patch a non-employee source +[**reject-non-employee-request**](#reject-non-employee-request) | **Post** `/non-employee-approvals/{id}/reject` | Reject a non-employee request +[**update-non-employee-record**](#update-non-employee-record) | **Put** `/non-employee-records/{id}` | Update non-employee record ## approve-non-employee-request -Approve a Non-Employee Request +Approve a non-employee request Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. [API Spec](https://developer.sailpoint.com/docs/api/v3/approve-non-employee-request) @@ -156,7 +156,7 @@ func main() { [[Back to top]](#) ## create-non-employee-record -Create Non-Employee Record +Create non-employee record This request will create a non-employee record. Requires role context of `idn:nesr:create` @@ -238,7 +238,7 @@ func main() { [[Back to top]](#) ## create-non-employee-request -Create Non-Employee Request +Create non-employee request This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-request) @@ -319,7 +319,7 @@ func main() { [[Back to top]](#) ## create-non-employee-source -Create Non-Employee Source +Create non-employee source Create a non-employee source. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source) @@ -411,7 +411,7 @@ func main() { [[Back to top]](#) ## create-non-employee-source-schema-attributes -Create a new Schema Attribute for Non-Employee Source +Create a new schema attribute for non-employee source This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. Requires role context of `idn:nesr:create` @@ -492,7 +492,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-record -Delete Non-Employee Record +Delete non-employee record This request will delete a non-employee record. Requires role context of `idn:nesr:delete` @@ -558,7 +558,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-records-in-bulk -Delete Multiple Non-Employee Records +Delete multiple non-employee records This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-records-in-bulk) @@ -624,7 +624,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-request -Delete Non-Employee Request +Delete non-employee request This request will delete a non-employee request. Requires role context of `idn:nesr:delete` @@ -690,7 +690,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-schema-attribute -Delete a Schema Attribute for Non-Employee Source +Delete a schema attribute for non-employee source This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` @@ -760,7 +760,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-source -Delete Non-Employee Source +Delete non-employee source This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source) @@ -825,7 +825,7 @@ func main() { [[Back to top]](#) ## delete-non-employee-source-schema-attributes -Delete all custom schema attributes for Non-Employee Source +Delete all custom schema attributes for non-employee source This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source-schema-attributes) @@ -890,7 +890,7 @@ func main() { [[Back to top]](#) ## export-non-employee-records -Exports Non-Employee Records to CSV +Exports non-employee records to csv This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` [API Spec](https://developer.sailpoint.com/docs/api/v3/export-non-employee-records) @@ -955,7 +955,7 @@ func main() { [[Back to top]](#) ## export-non-employee-source-schema-template -Exports Source Schema Template +Exports source schema template This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` [API Spec](https://developer.sailpoint.com/docs/api/v3/export-non-employee-source-schema-template) @@ -1091,7 +1091,7 @@ func main() { [[Back to top]](#) ## get-non-employee-approval-summary -Get Summary of Non-Employee Approval Requests +Get summary of non-employee approval requests This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. @@ -1229,7 +1229,7 @@ func main() { [[Back to top]](#) ## get-non-employee-record -Get a Non-Employee Record +Get a non-employee record This gets a non-employee record. Requires role context of `idn:nesr:read` @@ -1296,7 +1296,7 @@ func main() { [[Back to top]](#) ## get-non-employee-request -Get a Non-Employee Request +Get a non-employee request This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user @@ -1366,7 +1366,7 @@ func main() { [[Back to top]](#) ## get-non-employee-request-summary -Get Summary of Non-Employee Requests +Get summary of non-employee requests This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. @@ -1436,7 +1436,7 @@ func main() { [[Back to top]](#) ## get-non-employee-schema-attribute -Get Schema Attribute Non-Employee Source +Get schema attribute non-employee source This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-schema-attribute) @@ -1505,7 +1505,7 @@ func main() { [[Back to top]](#) ## get-non-employee-source -Get a Non-Employee Source +Get a non-employee source This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. @@ -1575,7 +1575,7 @@ func main() { [[Back to top]](#) ## get-non-employee-source-schema-attributes -List Schema Attributes Non-Employee Source +List schema attributes non-employee source This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. @@ -1642,7 +1642,7 @@ func main() { [[Back to top]](#) ## import-non-employee-records-in-bulk -Imports, or Updates, Non-Employee Records +Imports, or updates, non-employee records This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` [API Spec](https://developer.sailpoint.com/docs/api/v3/import-non-employee-records-in-bulk) @@ -1710,7 +1710,7 @@ func main() { [[Back to top]](#) ## list-non-employee-approvals -Get List of Non-Employee Approval Requests +Get list of non-employee approval requests This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they @@ -1786,7 +1786,7 @@ func main() { [[Back to top]](#) ## list-non-employee-records -List Non-Employee Records +List non-employee records This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. @@ -1858,7 +1858,7 @@ func main() { [[Back to top]](#) ## list-non-employee-requests -List Non-Employee Requests +List non-employee requests This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. @@ -1934,7 +1934,7 @@ func main() { [[Back to top]](#) ## list-non-employee-sources -List Non-Employee Sources +List non-employee sources Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. @@ -2008,7 +2008,7 @@ func main() { [[Back to top]](#) ## patch-non-employee-record -Patch Non-Employee Record +Patch non-employee record This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. @@ -2085,7 +2085,7 @@ func main() { [[Back to top]](#) ## patch-non-employee-schema-attribute -Patch a Schema Attribute for Non-Employee Source +Patch a schema attribute for non-employee source This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` @@ -2163,7 +2163,7 @@ func main() { [[Back to top]](#) ## patch-non-employee-source -Patch a Non-Employee Source +Patch a non-employee source patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. [API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-source) @@ -2236,7 +2236,7 @@ func main() { [[Back to top]](#) ## reject-non-employee-request -Reject a Non-Employee Request +Reject a non-employee request This endpoint will reject an approval item request and notify user. The current user must be the requested approver. [API Spec](https://developer.sailpoint.com/docs/api/v3/reject-non-employee-request) @@ -2311,7 +2311,7 @@ func main() { [[Back to top]](#) ## update-non-employee-record -Update Non-Employee Record +Update non-employee record This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. diff --git a/docs/tools/sdk/go/Reference/V3/Methods/OAuthClientsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/OAuthClientsAPI.md index c6f9693bc..04d58ad84 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/OAuthClientsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/OAuthClientsAPI.md @@ -18,15 +18,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-oauth-client**](#create-oauth-client) | **Post** `/oauth-clients` | Create OAuth Client -[**delete-oauth-client**](#delete-oauth-client) | **Delete** `/oauth-clients/{id}` | Delete OAuth Client -[**get-oauth-client**](#get-oauth-client) | **Get** `/oauth-clients/{id}` | Get OAuth Client -[**list-oauth-clients**](#list-oauth-clients) | **Get** `/oauth-clients` | List OAuth Clients -[**patch-oauth-client**](#patch-oauth-client) | **Patch** `/oauth-clients/{id}` | Patch OAuth Client +[**create-oauth-client**](#create-oauth-client) | **Post** `/oauth-clients` | Create oauth client +[**delete-oauth-client**](#delete-oauth-client) | **Delete** `/oauth-clients/{id}` | Delete oauth client +[**get-oauth-client**](#get-oauth-client) | **Get** `/oauth-clients/{id}` | Get oauth client +[**list-oauth-clients**](#list-oauth-clients) | **Get** `/oauth-clients` | List oauth clients +[**patch-oauth-client**](#patch-oauth-client) | **Patch** `/oauth-clients/{id}` | Patch oauth client ## create-oauth-client -Create OAuth Client +Create oauth client This creates an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-oauth-client) @@ -109,7 +109,7 @@ func main() { [[Back to top]](#) ## delete-oauth-client -Delete OAuth Client +Delete oauth client This deletes an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-oauth-client) @@ -174,7 +174,7 @@ func main() { [[Back to top]](#) ## get-oauth-client -Get OAuth Client +Get oauth client This gets details of an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-oauth-client) @@ -240,7 +240,7 @@ func main() { [[Back to top]](#) ## list-oauth-clients -List OAuth Clients +List oauth clients This gets a list of OAuth clients. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-oauth-clients) @@ -302,7 +302,7 @@ func main() { [[Back to top]](#) ## patch-oauth-client -Patch OAuth Client +Patch oauth client This performs a targeted update to the field(s) of an OAuth client. [API Spec](https://developer.sailpoint.com/docs/api/v3/patch-oauth-client) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PasswordConfigurationAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PasswordConfigurationAPI.md index 8ef9f9c4a..c71891e85 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/PasswordConfigurationAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/PasswordConfigurationAPI.md @@ -21,13 +21,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-password-org-config**](#create-password-org-config) | **Post** `/password-org-config` | Create Password Org Config -[**get-password-org-config**](#get-password-org-config) | **Get** `/password-org-config` | Get Password Org Config -[**put-password-org-config**](#put-password-org-config) | **Put** `/password-org-config` | Update Password Org Config +[**create-password-org-config**](#create-password-org-config) | **Post** `/password-org-config` | Create password org config +[**get-password-org-config**](#get-password-org-config) | **Get** `/password-org-config` | Get password org config +[**put-password-org-config**](#put-password-org-config) | **Put** `/password-org-config` | Update password org config ## create-password-org-config -Create Password Org Config +Create password org config This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' @@ -101,7 +101,7 @@ func main() { [[Back to top]](#) ## get-password-org-config -Get Password Org Config +Get password org config This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' [API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-org-config) @@ -158,7 +158,7 @@ func main() { [[Back to top]](#) ## put-password-org-config -Update Password Org Config +Update password org config This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PasswordDictionaryAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PasswordDictionaryAPI.md index 7777545ec..8d2bd6fee 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/PasswordDictionaryAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/PasswordDictionaryAPI.md @@ -62,12 +62,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-password-dictionary**](#get-password-dictionary) | **Get** `/password-dictionary` | Get Password Dictionary -[**put-password-dictionary**](#put-password-dictionary) | **Put** `/password-dictionary` | Update Password Dictionary +[**get-password-dictionary**](#get-password-dictionary) | **Get** `/password-dictionary` | Get password dictionary +[**put-password-dictionary**](#put-password-dictionary) | **Put** `/password-dictionary` | Update password dictionary ## get-password-dictionary -Get Password Dictionary +Get password dictionary This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing @@ -152,7 +152,7 @@ func main() { [[Back to top]](#) ## put-password-dictionary -Update Password Dictionary +Update password dictionary This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PasswordManagementAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PasswordManagementAPI.md index c4cabad24..518ab8616 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/PasswordManagementAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/PasswordManagementAPI.md @@ -39,13 +39,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-password-change-status**](#get-password-change-status) | **Get** `/password-change-status/{id}` | Get Password Change Request Status -[**query-password-info**](#query-password-info) | **Post** `/query-password-info` | Query Password Info -[**set-password**](#set-password) | **Post** `/set-password` | Set Identity's Password +[**get-password-change-status**](#get-password-change-status) | **Get** `/password-change-status/{id}` | Get password change request status +[**query-password-info**](#query-password-info) | **Post** `/query-password-info` | Query password info +[**set-password**](#set-password) | **Post** `/set-password` | Set identity's password ## get-password-change-status -Get Password Change Request Status +Get password change request status This API returns the status of a password change request. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-change-status) @@ -111,7 +111,7 @@ func main() { [[Back to top]](#) ## query-password-info -Query Password Info +Query password info This API is used to query password related information. @@ -182,7 +182,7 @@ func main() { [[Back to top]](#) ## set-password -Set Identity's Password +Set identity's password This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PasswordPoliciesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PasswordPoliciesAPI.md index 0d2e9fd9f..e0f5f2f8c 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/PasswordPoliciesAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/PasswordPoliciesAPI.md @@ -23,15 +23,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-password-policy**](#create-password-policy) | **Post** `/password-policies` | Create Password Policy -[**delete-password-policy**](#delete-password-policy) | **Delete** `/password-policies/{id}` | Delete Password Policy by ID -[**get-password-policy-by-id**](#get-password-policy-by-id) | **Get** `/password-policies/{id}` | Get Password Policy by ID -[**list-password-policies**](#list-password-policies) | **Get** `/password-policies` | List Password Policies -[**set-password-policy**](#set-password-policy) | **Put** `/password-policies/{id}` | Update Password Policy by ID +[**create-password-policy**](#create-password-policy) | **Post** `/password-policies` | Create password policy +[**delete-password-policy**](#delete-password-policy) | **Delete** `/password-policies/{id}` | Delete password policy by id +[**get-password-policy-by-id**](#get-password-policy-by-id) | **Get** `/password-policies/{id}` | Get password policy by id +[**list-password-policies**](#list-password-policies) | **Get** `/password-policies` | List password policies +[**set-password-policy**](#set-password-policy) | **Put** `/password-policies/{id}` | Update password policy by id ## create-password-policy -Create Password Policy +Create password policy This API creates the specified password policy. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-policy) @@ -130,7 +130,7 @@ func main() { [[Back to top]](#) ## delete-password-policy -Delete Password Policy by ID +Delete password policy by id This API deletes the specified password policy. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-password-policy) @@ -195,7 +195,7 @@ func main() { [[Back to top]](#) ## get-password-policy-by-id -Get Password Policy by ID +Get password policy by id This API returns the password policy for the specified ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-policy-by-id) @@ -261,7 +261,7 @@ func main() { [[Back to top]](#) ## list-password-policies -List Password Policies +List password policies This gets list of all Password Policies. Requires role of ORG_ADMIN @@ -328,7 +328,7 @@ func main() { [[Back to top]](#) ## set-password-policy -Update Password Policy by ID +Update password policy by id This API updates the specified password policy. [API Spec](https://developer.sailpoint.com/docs/api/v3/set-password-policy) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PasswordSyncGroupsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PasswordSyncGroupsAPI.md index 2a1ae1707..ddccbac95 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/PasswordSyncGroupsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/PasswordSyncGroupsAPI.md @@ -47,15 +47,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-password-sync-group**](#create-password-sync-group) | **Post** `/password-sync-groups` | Create Password Sync Group -[**delete-password-sync-group**](#delete-password-sync-group) | **Delete** `/password-sync-groups/{id}` | Delete Password Sync Group by ID -[**get-password-sync-group**](#get-password-sync-group) | **Get** `/password-sync-groups/{id}` | Get Password Sync Group by ID -[**get-password-sync-groups**](#get-password-sync-groups) | **Get** `/password-sync-groups` | Get Password Sync Group List -[**update-password-sync-group**](#update-password-sync-group) | **Put** `/password-sync-groups/{id}` | Update Password Sync Group by ID +[**create-password-sync-group**](#create-password-sync-group) | **Post** `/password-sync-groups` | Create password sync group +[**delete-password-sync-group**](#delete-password-sync-group) | **Delete** `/password-sync-groups/{id}` | Delete password sync group by id +[**get-password-sync-group**](#get-password-sync-group) | **Get** `/password-sync-groups/{id}` | Get password sync group by id +[**get-password-sync-groups**](#get-password-sync-groups) | **Get** `/password-sync-groups` | Get password sync group list +[**update-password-sync-group**](#update-password-sync-group) | **Put** `/password-sync-groups/{id}` | Update password sync group by id ## create-password-sync-group -Create Password Sync Group +Create password sync group This API creates a password sync group based on the specifications provided. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-sync-group) @@ -129,7 +129,7 @@ func main() { [[Back to top]](#) ## delete-password-sync-group -Delete Password Sync Group by ID +Delete password sync group by id This API deletes the specified password sync group. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-password-sync-group) @@ -194,7 +194,7 @@ func main() { [[Back to top]](#) ## get-password-sync-group -Get Password Sync Group by ID +Get password sync group by id This API returns the sync group for the specified ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-sync-group) @@ -260,7 +260,7 @@ func main() { [[Back to top]](#) ## get-password-sync-groups -Get Password Sync Group List +Get password sync group list This API returns a list of password sync groups. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-sync-groups) @@ -326,7 +326,7 @@ func main() { [[Back to top]](#) ## update-password-sync-group -Update Password Sync Group by ID +Update password sync group by id This API updates the specified password sync group. [API Spec](https://developer.sailpoint.com/docs/api/v3/update-password-sync-group) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PersonalAccessTokensAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PersonalAccessTokensAPI.md index 999ce520b..21bb917f5 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/PersonalAccessTokensAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/PersonalAccessTokensAPI.md @@ -26,14 +26,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-personal-access-token**](#create-personal-access-token) | **Post** `/personal-access-tokens` | Create Personal Access Token -[**delete-personal-access-token**](#delete-personal-access-token) | **Delete** `/personal-access-tokens/{id}` | Delete Personal Access Token -[**list-personal-access-tokens**](#list-personal-access-tokens) | **Get** `/personal-access-tokens` | List Personal Access Tokens -[**patch-personal-access-token**](#patch-personal-access-token) | **Patch** `/personal-access-tokens/{id}` | Patch Personal Access Token +[**create-personal-access-token**](#create-personal-access-token) | **Post** `/personal-access-tokens` | Create personal access token +[**delete-personal-access-token**](#delete-personal-access-token) | **Delete** `/personal-access-tokens/{id}` | Delete personal access token +[**list-personal-access-tokens**](#list-personal-access-tokens) | **Get** `/personal-access-tokens` | List personal access tokens +[**patch-personal-access-token**](#patch-personal-access-token) | **Patch** `/personal-access-tokens/{id}` | Patch personal access token ## create-personal-access-token -Create Personal Access Token +Create personal access token This creates a personal access token. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-personal-access-token) @@ -104,7 +104,7 @@ func main() { [[Back to top]](#) ## delete-personal-access-token -Delete Personal Access Token +Delete personal access token This deletes a personal access token. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-personal-access-token) @@ -169,7 +169,7 @@ func main() { [[Back to top]](#) ## list-personal-access-tokens -List Personal Access Tokens +List personal access tokens This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-personal-access-tokens) @@ -233,7 +233,7 @@ func main() { [[Back to top]](#) ## patch-personal-access-token -Patch Personal Access Token +Patch personal access token This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PublicIdentitiesConfigAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PublicIdentitiesConfigAPI.md index 32f90813f..7d89924d9 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/PublicIdentitiesConfigAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/PublicIdentitiesConfigAPI.md @@ -25,12 +25,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get-public-identity-config**](#get-public-identity-config) | **Get** `/public-identities-config` | Get the Public Identities Configuration -[**update-public-identity-config**](#update-public-identity-config) | **Put** `/public-identities-config` | Update the Public Identities Configuration +[**get-public-identity-config**](#get-public-identity-config) | **Get** `/public-identities-config` | Get the public identities configuration +[**update-public-identity-config**](#update-public-identity-config) | **Put** `/public-identities-config` | Update the public identities configuration ## get-public-identity-config -Get the Public Identities Configuration +Get the public identities configuration Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-public-identity-config) @@ -87,7 +87,7 @@ func main() { [[Back to top]](#) ## update-public-identity-config -Update the Public Identities Configuration +Update the public identities configuration Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. [API Spec](https://developer.sailpoint.com/docs/api/v3/update-public-identity-config) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ReportsDataExtractionAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ReportsDataExtractionAPI.md index 0ffb984aa..b66b1b364 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/ReportsDataExtractionAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/ReportsDataExtractionAPI.md @@ -18,14 +18,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**cancel-report**](#cancel-report) | **Post** `/reports/{id}/cancel` | Cancel Report -[**get-report**](#get-report) | **Get** `/reports/{taskResultId}` | Get Report File -[**get-report-result**](#get-report-result) | **Get** `/reports/{taskResultId}/result` | Get Report Result -[**start-report**](#start-report) | **Post** `/reports/run` | Run Report +[**cancel-report**](#cancel-report) | **Post** `/reports/{id}/cancel` | Cancel report +[**get-report**](#get-report) | **Get** `/reports/{taskResultId}` | Get report file +[**get-report-result**](#get-report-result) | **Get** `/reports/{taskResultId}/result` | Get report result +[**start-report**](#start-report) | **Post** `/reports/run` | Run report ## cancel-report -Cancel Report +Cancel report Cancels a running report. [API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-report) @@ -90,7 +90,7 @@ func main() { [[Back to top]](#) ## get-report -Get Report File +Get report file Gets a report in file format. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-report) @@ -162,7 +162,7 @@ func main() { [[Back to top]](#) ## get-report-result -Get Report Result +Get report result Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-report-result) @@ -230,7 +230,7 @@ func main() { [[Back to top]](#) ## start-report -Run Report +Run report Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. [API Spec](https://developer.sailpoint.com/docs/api/v3/start-report) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/RequestableObjectsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/RequestableObjectsAPI.md index e7e8fdc2b..824b4cc0b 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/RequestableObjectsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/RequestableObjectsAPI.md @@ -18,11 +18,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**list-requestable-objects**](#list-requestable-objects) | **Get** `/requestable-objects` | Requestable Objects List +[**list-requestable-objects**](#list-requestable-objects) | **Get** `/requestable-objects` | Requestable objects list ## list-requestable-objects -Requestable Objects List +Requestable objects list Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items. diff --git a/docs/tools/sdk/go/Reference/V3/Methods/RolesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/RolesAPI.md index 595c27472..26db4c9f9 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/RolesAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/RolesAPI.md @@ -52,17 +52,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-role**](#create-role) | **Post** `/roles` | Create a Role -[**delete-bulk-roles**](#delete-bulk-roles) | **Post** `/roles/bulk-delete` | Delete Role(s) -[**delete-role**](#delete-role) | **Delete** `/roles/{id}` | Delete Role -[**get-role**](#get-role) | **Get** `/roles/{id}` | Get Role -[**get-role-assigned-identities**](#get-role-assigned-identities) | **Get** `/roles/{id}/assigned-identities` | List Identities assigned a Role -[**list-roles**](#list-roles) | **Get** `/roles` | List Roles -[**patch-role**](#patch-role) | **Patch** `/roles/{id}` | Patch Role +[**create-role**](#create-role) | **Post** `/roles` | Create a role +[**delete-bulk-roles**](#delete-bulk-roles) | **Post** `/roles/bulk-delete` | Delete role(s) +[**delete-role**](#delete-role) | **Delete** `/roles/{id}` | Delete role +[**get-role**](#get-role) | **Get** `/roles/{id}` | Get role +[**get-role-assigned-identities**](#get-role-assigned-identities) | **Get** `/roles/{id}/assigned-identities` | List identities assigned a role +[**list-roles**](#list-roles) | **Get** `/roles` | List roles +[**patch-role**](#patch-role) | **Patch** `/roles/{id}` | Patch role ## create-role -Create a Role +Create a role This API creates a role. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. @@ -290,7 +290,7 @@ func main() { [[Back to top]](#) ## delete-bulk-roles -Delete Role(s) +Delete role(s) This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. @@ -362,7 +362,7 @@ func main() { [[Back to top]](#) ## delete-role -Delete Role +Delete role Delete a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of. @@ -429,7 +429,7 @@ func main() { [[Back to top]](#) ## get-role -Get Role +Get role Get a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. @@ -496,7 +496,7 @@ func main() { [[Back to top]](#) ## get-role-assigned-identities -List Identities assigned a Role +List identities assigned a role [API Spec](https://developer.sailpoint.com/docs/api/v3/get-role-assigned-identities) @@ -572,7 +572,7 @@ func main() { [[Back to top]](#) ## list-roles -List Roles +List roles This API returns a list of Roles. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-roles) @@ -648,7 +648,7 @@ func main() { [[Back to top]](#) ## patch-role -Patch Role +Patch role Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SODPoliciesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SODPoliciesAPI.md index b3b1ddfb1..ec55e14ce 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/SODPoliciesAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/SODPoliciesAPI.md @@ -41,27 +41,27 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-sod-policy**](#create-sod-policy) | **Post** `/sod-policies` | Create SOD policy -[**delete-sod-policy**](#delete-sod-policy) | **Delete** `/sod-policies/{id}` | Delete SOD policy by ID -[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **Delete** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**create-sod-policy**](#create-sod-policy) | **Post** `/sod-policies` | Create sod policy +[**delete-sod-policy**](#delete-sod-policy) | **Delete** `/sod-policies/{id}` | Delete sod policy by id +[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **Delete** `/sod-policies/{id}/schedule` | Delete sod policy schedule [**get-custom-violation-report**](#get-custom-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report [**get-default-violation-report**](#get-default-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download` | Download violation report [**get-sod-all-report-run-status**](#get-sod-all-report-run-status) | **Get** `/sod-violation-report` | Get multi-report run task status -[**get-sod-policy**](#get-sod-policy) | **Get** `/sod-policies/{id}` | Get SOD policy by ID -[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **Get** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**get-sod-policy**](#get-sod-policy) | **Get** `/sod-policies/{id}` | Get sod policy by id +[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **Get** `/sod-policies/{id}/schedule` | Get sod policy schedule [**get-sod-violation-report-run-status**](#get-sod-violation-report-run-status) | **Get** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status -[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **Get** `/sod-policies/{id}/violation-report` | Get SOD violation report status -[**list-sod-policies**](#list-sod-policies) | **Get** `/sod-policies` | List SOD policies -[**patch-sod-policy**](#patch-sod-policy) | **Patch** `/sod-policies/{id}` | Patch SOD policy by ID -[**put-policy-schedule**](#put-policy-schedule) | **Put** `/sod-policies/{id}/schedule` | Update SOD Policy schedule -[**put-sod-policy**](#put-sod-policy) | **Put** `/sod-policies/{id}` | Update SOD policy by ID -[**start-evaluate-sod-policy**](#start-evaluate-sod-policy) | **Post** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID +[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **Get** `/sod-policies/{id}/violation-report` | Get sod violation report status +[**list-sod-policies**](#list-sod-policies) | **Get** `/sod-policies` | List sod policies +[**patch-sod-policy**](#patch-sod-policy) | **Patch** `/sod-policies/{id}` | Patch sod policy by id +[**put-policy-schedule**](#put-policy-schedule) | **Put** `/sod-policies/{id}/schedule` | Update sod policy schedule +[**put-sod-policy**](#put-sod-policy) | **Put** `/sod-policies/{id}` | Update sod policy by id +[**start-evaluate-sod-policy**](#start-evaluate-sod-policy) | **Post** `/sod-policies/{id}/evaluate` | Evaluate one policy by id [**start-sod-all-policies-for-org**](#start-sod-all-policies-for-org) | **Post** `/sod-violation-report/run` | Runs all policies for org -[**start-sod-policy**](#start-sod-policy) | **Post** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report +[**start-sod-policy**](#start-sod-policy) | **Post** `/sod-policies/{id}/violation-report/run` | Runs sod policy violation report ## create-sod-policy -Create SOD policy +Create sod policy This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. @@ -184,7 +184,7 @@ func main() { [[Back to top]](#) ## delete-sod-policy -Delete SOD policy by ID +Delete sod policy by id This deletes a specified SOD policy. Requires role of ORG_ADMIN. @@ -252,7 +252,7 @@ func main() { [[Back to top]](#) ## delete-sod-policy-schedule -Delete SOD policy schedule +Delete sod policy schedule This deletes schedule for a specified SOD policy by ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-sod-policy-schedule) @@ -509,7 +509,7 @@ func main() { [[Back to top]](#) ## get-sod-policy -Get SOD policy by ID +Get sod policy by id This gets specified SOD policy. Requires role of ORG_ADMIN. @@ -576,7 +576,7 @@ func main() { [[Back to top]](#) ## get-sod-policy-schedule -Get SOD policy schedule +Get sod policy schedule This endpoint gets a specified SOD policy's schedule. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-policy-schedule) @@ -708,7 +708,7 @@ func main() { [[Back to top]](#) ## get-sod-violation-report-status -Get SOD violation report status +Get sod violation report status This gets the status for a violation report run task that has already been invoked. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-violation-report-status) @@ -774,7 +774,7 @@ func main() { [[Back to top]](#) ## list-sod-policies -List SOD policies +List sod policies This gets list of all SOD policies. Requires role of ORG_ADMIN @@ -845,7 +845,7 @@ func main() { [[Back to top]](#) ## patch-sod-policy -Patch SOD policy by ID +Patch sod policy by id Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. @@ -920,7 +920,7 @@ func main() { [[Back to top]](#) ## put-policy-schedule -Update SOD Policy schedule +Update sod policy schedule This updates schedule for a specified SOD policy. [API Spec](https://developer.sailpoint.com/docs/api/v3/put-policy-schedule) @@ -1030,7 +1030,7 @@ func main() { [[Back to top]](#) ## put-sod-policy -Update SOD policy by ID +Update sod policy by id This updates a specified SOD policy. Requires role of ORG_ADMIN. @@ -1159,7 +1159,7 @@ func main() { [[Back to top]](#) ## start-evaluate-sod-policy -Evaluate one policy by ID +Evaluate one policy by id Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/start-evaluate-sod-policy) @@ -1289,7 +1289,7 @@ func main() { [[Back to top]](#) ## start-sod-policy -Runs SOD policy violation report +Runs sod policy violation report This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. [API Spec](https://developer.sailpoint.com/docs/api/v3/start-sod-policy) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SODViolationsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SODViolationsAPI.md index 2a31925dd..7cd2b8b85 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/SODViolationsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/SODViolationsAPI.md @@ -33,12 +33,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**start-predict-sod-violations**](#start-predict-sod-violations) | **Post** `/sod-violations/predict` | Predict SOD violations for identity. -[**start-violation-check**](#start-violation-check) | **Post** `/sod-violations/check` | Check SOD violations +[**start-predict-sod-violations**](#start-predict-sod-violations) | **Post** `/sod-violations/predict` | Predict sod violations for identity. +[**start-violation-check**](#start-violation-check) | **Post** `/sod-violations/check` | Check sod violations ## start-predict-sod-violations -Predict SOD violations for identity. +Predict sod violations for identity. This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. [API Spec](https://developer.sailpoint.com/docs/api/v3/start-predict-sod-violations) @@ -116,7 +116,7 @@ func main() { [[Back to top]](#) ## start-violation-check -Check SOD violations +Check sod violations This API initiates a SOD policy verification asynchronously. [API Spec](https://developer.sailpoint.com/docs/api/v3/start-violation-check) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SavedSearchAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SavedSearchAPI.md index 57aef35ec..a8a95ca9e 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/SavedSearchAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/SavedSearchAPI.md @@ -26,10 +26,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-saved-search**](#create-saved-search) | **Post** `/saved-searches` | Create a saved search -[**delete-saved-search**](#delete-saved-search) | **Delete** `/saved-searches/{id}` | Delete document by ID -[**execute-saved-search**](#execute-saved-search) | **Post** `/saved-searches/{id}/execute` | Execute a saved search by ID -[**get-saved-search**](#get-saved-search) | **Get** `/saved-searches/{id}` | Return saved search by ID -[**list-saved-searches**](#list-saved-searches) | **Get** `/saved-searches` | A list of Saved Searches +[**delete-saved-search**](#delete-saved-search) | **Delete** `/saved-searches/{id}` | Delete document by id +[**execute-saved-search**](#execute-saved-search) | **Post** `/saved-searches/{id}/execute` | Execute a saved search by id +[**get-saved-search**](#get-saved-search) | **Get** `/saved-searches/{id}` | Return saved search by id +[**list-saved-searches**](#list-saved-searches) | **Get** `/saved-searches` | A list of saved searches [**put-saved-search**](#put-saved-search) | **Put** `/saved-searches/{id}` | Updates an existing saved search @@ -102,7 +102,7 @@ func main() { [[Back to top]](#) ## delete-saved-search -Delete document by ID +Delete document by id Deletes the specified saved search. @@ -168,7 +168,7 @@ func main() { [[Back to top]](#) ## execute-saved-search -Execute a saved search by ID +Execute a saved search by id Executes the specified saved search. @@ -251,7 +251,7 @@ func main() { [[Back to top]](#) ## get-saved-search -Return saved search by ID +Return saved search by id Returns the specified saved search. @@ -318,7 +318,7 @@ func main() { [[Back to top]](#) ## list-saved-searches -A list of Saved Searches +A list of saved searches Returns a list of saved searches. diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ScheduledSearchAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ScheduledSearchAPI.md index b43a554a4..6e5c85f3a 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/ScheduledSearchAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/ScheduledSearchAPI.md @@ -42,11 +42,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-scheduled-search**](#create-scheduled-search) | **Post** `/scheduled-searches` | Create a new scheduled search -[**delete-scheduled-search**](#delete-scheduled-search) | **Delete** `/scheduled-searches/{id}` | Delete a Scheduled Search -[**get-scheduled-search**](#get-scheduled-search) | **Get** `/scheduled-searches/{id}` | Get a Scheduled Search +[**delete-scheduled-search**](#delete-scheduled-search) | **Delete** `/scheduled-searches/{id}` | Delete a scheduled search +[**get-scheduled-search**](#get-scheduled-search) | **Get** `/scheduled-searches/{id}` | Get a scheduled search [**list-scheduled-search**](#list-scheduled-search) | **Get** `/scheduled-searches` | List scheduled searches -[**unsubscribe-scheduled-search**](#unsubscribe-scheduled-search) | **Post** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search -[**update-scheduled-search**](#update-scheduled-search) | **Put** `/scheduled-searches/{id}` | Update an existing Scheduled Search +[**unsubscribe-scheduled-search**](#unsubscribe-scheduled-search) | **Post** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from scheduled search +[**update-scheduled-search**](#update-scheduled-search) | **Put** `/scheduled-searches/{id}` | Update an existing scheduled search ## create-scheduled-search @@ -118,7 +118,7 @@ func main() { [[Back to top]](#) ## delete-scheduled-search -Delete a Scheduled Search +Delete a scheduled search Deletes the specified scheduled search. @@ -184,7 +184,7 @@ func main() { [[Back to top]](#) ## get-scheduled-search -Get a Scheduled Search +Get a scheduled search Returns the specified scheduled search. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-scheduled-search) @@ -319,7 +319,7 @@ func main() { [[Back to top]](#) ## unsubscribe-scheduled-search -Unsubscribe a recipient from Scheduled Search +Unsubscribe a recipient from scheduled search Unsubscribes a recipient from the specified scheduled search. @@ -395,7 +395,7 @@ func main() { [[Back to top]](#) ## update-scheduled-search -Update an existing Scheduled Search +Update an existing scheduled search Updates an existing scheduled search. diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SearchAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SearchAPI.md index 8a73868ae..041e55fad 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/SearchAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/SearchAPI.md @@ -38,14 +38,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**search-aggregate**](#search-aggregate) | **Post** `/search/aggregate` | Perform a Search Query Aggregation -[**search-count**](#search-count) | **Post** `/search/count` | Count Documents Satisfying a Query -[**search-get**](#search-get) | **Get** `/search/{index}/{id}` | Get a Document by ID -[**search-post**](#search-post) | **Post** `/search` | Perform Search +[**search-aggregate**](#search-aggregate) | **Post** `/search/aggregate` | Perform a search query aggregation +[**search-count**](#search-count) | **Post** `/search/count` | Count documents satisfying a query +[**search-get**](#search-get) | **Get** `/search/{index}/{id}` | Get a document by id +[**search-post**](#search-post) | **Post** `/search` | Perform search ## search-aggregate -Perform a Search Query Aggregation +Perform a search query aggregation Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. [API Spec](https://developer.sailpoint.com/docs/api/v3/search-aggregate) @@ -234,7 +234,7 @@ func main() { [[Back to top]](#) ## search-count -Count Documents Satisfying a Query +Count documents satisfying a query Performs a search with a provided query and returns the count of results in the X-Total-Count header. [API Spec](https://developer.sailpoint.com/docs/api/v3/search-count) @@ -416,7 +416,7 @@ func main() { [[Back to top]](#) ## search-get -Get a Document by ID +Get a document by id Fetches a single document from the specified index, using the specified document ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/search-get) @@ -485,7 +485,7 @@ func main() { [[Back to top]](#) ## search-post -Perform Search +Perform search Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. [API Spec](https://developer.sailpoint.com/docs/api/v3/search-post) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SearchAttributeConfigurationAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SearchAttributeConfigurationAPI.md index a0686d245..8c4e39553 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/SearchAttributeConfigurationAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/SearchAttributeConfigurationAPI.md @@ -33,15 +33,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-search-attribute-config**](#create-search-attribute-config) | **Post** `/accounts/search-attribute-config` | Create Extended Search Attributes -[**delete-search-attribute-config**](#delete-search-attribute-config) | **Delete** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute -[**get-search-attribute-config**](#get-search-attribute-config) | **Get** `/accounts/search-attribute-config` | List Extended Search Attributes -[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **Get** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute -[**patch-search-attribute-config**](#patch-search-attribute-config) | **Patch** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute +[**create-search-attribute-config**](#create-search-attribute-config) | **Post** `/accounts/search-attribute-config` | Create extended search attributes +[**delete-search-attribute-config**](#delete-search-attribute-config) | **Delete** `/accounts/search-attribute-config/{name}` | Delete extended search attribute +[**get-search-attribute-config**](#get-search-attribute-config) | **Get** `/accounts/search-attribute-config` | List extended search attributes +[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **Get** `/accounts/search-attribute-config/{name}` | Get extended search attribute +[**patch-search-attribute-config**](#patch-search-attribute-config) | **Patch** `/accounts/search-attribute-config/{name}` | Update extended search attribute ## create-search-attribute-config -Create Extended Search Attributes +Create extended search attributes Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** @@ -116,7 +116,7 @@ func main() { [[Back to top]](#) ## delete-search-attribute-config -Delete Extended Search Attribute +Delete extended search attribute Delete an extended attribute configuration by name. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-search-attribute-config) @@ -181,7 +181,7 @@ func main() { [[Back to top]](#) ## get-search-attribute-config -List Extended Search Attributes +List extended search attributes Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/v3/get-search-attribute-config) @@ -245,7 +245,7 @@ func main() { [[Back to top]](#) ## get-single-search-attribute-config -Get Extended Search Attribute +Get extended search attribute Get an extended attribute configuration by name. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-single-search-attribute-config) @@ -311,7 +311,7 @@ func main() { [[Back to top]](#) ## patch-search-attribute-config -Update Extended Search Attribute +Update extended search attribute Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SegmentsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SegmentsAPI.md index bc337e718..d1af946a7 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/SegmentsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/SegmentsAPI.md @@ -32,15 +32,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-segment**](#create-segment) | **Post** `/segments` | Create Segment -[**delete-segment**](#delete-segment) | **Delete** `/segments/{id}` | Delete Segment by ID -[**get-segment**](#get-segment) | **Get** `/segments/{id}` | Get Segment by ID -[**list-segments**](#list-segments) | **Get** `/segments` | List Segments -[**patch-segment**](#patch-segment) | **Patch** `/segments/{id}` | Update Segment +[**create-segment**](#create-segment) | **Post** `/segments` | Create segment +[**delete-segment**](#delete-segment) | **Delete** `/segments/{id}` | Delete segment by id +[**get-segment**](#get-segment) | **Get** `/segments/{id}` | Get segment by id +[**list-segments**](#list-segments) | **Get** `/segments` | List segments +[**patch-segment**](#patch-segment) | **Patch** `/segments/{id}` | Update segment ## create-segment -Create Segment +Create segment This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. @@ -131,7 +131,7 @@ func main() { [[Back to top]](#) ## delete-segment -Delete Segment by ID +Delete segment by id This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. @@ -197,7 +197,7 @@ func main() { [[Back to top]](#) ## get-segment -Get Segment by ID +Get segment by id This API returns the segment specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-segment) @@ -263,7 +263,7 @@ func main() { [[Back to top]](#) ## list-segments -List Segments +List segments This API returns a list of all segments. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-segments) @@ -329,7 +329,7 @@ func main() { [[Back to top]](#) ## patch-segment -Update Segment +Update segment Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ServiceDeskIntegrationAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ServiceDeskIntegrationAPI.md index c1fc05c64..474e97ec5 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/ServiceDeskIntegrationAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/ServiceDeskIntegrationAPI.md @@ -39,20 +39,20 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-service-desk-integration**](#create-service-desk-integration) | **Post** `/service-desk-integrations` | Create new Service Desk integration -[**delete-service-desk-integration**](#delete-service-desk-integration) | **Delete** `/service-desk-integrations/{id}` | Delete a Service Desk integration -[**get-service-desk-integration**](#get-service-desk-integration) | **Get** `/service-desk-integrations/{id}` | Get a Service Desk integration -[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **Get** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName -[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **Get** `/service-desk-integrations/types` | List Service Desk integration types -[**get-service-desk-integrations**](#get-service-desk-integrations) | **Get** `/service-desk-integrations` | List existing Service Desk integrations +[**create-service-desk-integration**](#create-service-desk-integration) | **Post** `/service-desk-integrations` | Create new service desk integration +[**delete-service-desk-integration**](#delete-service-desk-integration) | **Delete** `/service-desk-integrations/{id}` | Delete a service desk integration +[**get-service-desk-integration**](#get-service-desk-integration) | **Get** `/service-desk-integrations/{id}` | Get a service desk integration +[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **Get** `/service-desk-integrations/templates/{scriptName}` | Service desk integration template by scriptname +[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **Get** `/service-desk-integrations/types` | List service desk integration types +[**get-service-desk-integrations**](#get-service-desk-integrations) | **Get** `/service-desk-integrations` | List existing service desk integrations [**get-status-check-details**](#get-status-check-details) | **Get** `/service-desk-integrations/status-check-configuration` | Get the time check configuration -[**patch-service-desk-integration**](#patch-service-desk-integration) | **Patch** `/service-desk-integrations/{id}` | Patch a Service Desk Integration -[**put-service-desk-integration**](#put-service-desk-integration) | **Put** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**patch-service-desk-integration**](#patch-service-desk-integration) | **Patch** `/service-desk-integrations/{id}` | Patch a service desk integration +[**put-service-desk-integration**](#put-service-desk-integration) | **Put** `/service-desk-integrations/{id}` | Update a service desk integration [**update-status-check-details**](#update-status-check-details) | **Put** `/service-desk-integrations/status-check-configuration` | Update the time check configuration ## create-service-desk-integration -Create new Service Desk integration +Create new service desk integration Create a new Service Desk integration. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-service-desk-integration) @@ -152,7 +152,7 @@ func main() { [[Back to top]](#) ## delete-service-desk-integration -Delete a Service Desk integration +Delete a service desk integration Delete an existing Service Desk integration by ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-service-desk-integration) @@ -217,7 +217,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integration -Get a Service Desk integration +Get a service desk integration Get an existing Service Desk integration by ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration) @@ -283,7 +283,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integration-template -Service Desk integration template by scriptName +Service desk integration template by scriptname This API endpoint returns an existing Service Desk integration template by scriptName. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration-template) @@ -349,7 +349,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integration-types -List Service Desk integration types +List service desk integration types This API endpoint returns the current list of supported Service Desk integration types. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration-types) @@ -406,7 +406,7 @@ func main() { [[Back to top]](#) ## get-service-desk-integrations -List existing Service Desk integrations +List existing service desk integrations Get a list of Service Desk integration objects. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integrations) @@ -533,7 +533,7 @@ func main() { [[Back to top]](#) ## patch-service-desk-integration -Patch a Service Desk Integration +Patch a service desk integration Update an existing Service Desk integration by ID with a PATCH request. [API Spec](https://developer.sailpoint.com/docs/api/v3/patch-service-desk-integration) @@ -606,7 +606,7 @@ func main() { [[Back to top]](#) ## put-service-desk-integration -Update a Service Desk integration +Update a service desk integration Update an existing Service Desk integration by ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/put-service-desk-integration) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SourcesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SourcesAPI.md index 9359fa742..a2f92aefb 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/SourcesAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/SourcesAPI.md @@ -72,36 +72,36 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-provisioning-policy**](#create-provisioning-policy) | **Post** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy -[**create-source**](#create-source) | **Post** `/sources` | Creates a source in IdentityNow. -[**create-source-schema**](#create-source-schema) | **Post** `/sources/{sourceId}/schemas` | Create Schema on Source -[**delete-provisioning-policy**](#delete-provisioning-policy) | **Delete** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType -[**delete-source**](#delete-source) | **Delete** `/sources/{id}` | Delete Source by ID -[**delete-source-schema**](#delete-source-schema) | **Delete** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**create-provisioning-policy**](#create-provisioning-policy) | **Post** `/sources/{sourceId}/provisioning-policies` | Create provisioning policy +[**create-source**](#create-source) | **Post** `/sources` | Creates a source in identitynow. +[**create-source-schema**](#create-source-schema) | **Post** `/sources/{sourceId}/schemas` | Create schema on source +[**delete-provisioning-policy**](#delete-provisioning-policy) | **Delete** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype +[**delete-source**](#delete-source) | **Delete** `/sources/{id}` | Delete source by id +[**delete-source-schema**](#delete-source-schema) | **Delete** `/sources/{sourceId}/schemas/{schemaId}` | Delete source schema by id [**get-accounts-schema**](#get-accounts-schema) | **Get** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template [**get-entitlements-schema**](#get-entitlements-schema) | **Get** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template -[**get-provisioning-policy**](#get-provisioning-policy) | **Get** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType -[**get-source**](#get-source) | **Get** `/sources/{id}` | Get Source by ID -[**get-source-connections**](#get-source-connections) | **Get** `/sources/{sourceId}/connections` | Get Source Connections by ID +[**get-provisioning-policy**](#get-provisioning-policy) | **Get** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype +[**get-source**](#get-source) | **Get** `/sources/{id}` | Get source by id +[**get-source-connections**](#get-source-connections) | **Get** `/sources/{sourceId}/connections` | Get source connections by id [**get-source-health**](#get-source-health) | **Get** `/sources/{sourceId}/source-health` | Fetches source health by id -[**get-source-schema**](#get-source-schema) | **Get** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID -[**get-source-schemas**](#get-source-schemas) | **Get** `/sources/{sourceId}/schemas` | List Schemas on Source +[**get-source-schema**](#get-source-schema) | **Get** `/sources/{sourceId}/schemas/{schemaId}` | Get source schema by id +[**get-source-schemas**](#get-source-schemas) | **Get** `/sources/{sourceId}/schemas` | List schemas on source [**import-accounts-schema**](#import-accounts-schema) | **Post** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template [**import-connector-file**](#import-connector-file) | **Post** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source [**import-entitlements-schema**](#import-entitlements-schema) | **Post** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template -[**list-provisioning-policies**](#list-provisioning-policies) | **Get** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies -[**list-sources**](#list-sources) | **Get** `/sources` | Lists all sources in IdentityNow. -[**put-provisioning-policy**](#put-provisioning-policy) | **Put** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType -[**put-source**](#put-source) | **Put** `/sources/{id}` | Update Source (Full) -[**put-source-schema**](#put-source-schema) | **Put** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) -[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **Post** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies -[**update-provisioning-policy**](#update-provisioning-policy) | **Patch** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy -[**update-source**](#update-source) | **Patch** `/sources/{id}` | Update Source (Partial) -[**update-source-schema**](#update-source-schema) | **Patch** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) +[**list-provisioning-policies**](#list-provisioning-policies) | **Get** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies +[**list-sources**](#list-sources) | **Get** `/sources` | Lists all sources in identitynow. +[**put-provisioning-policy**](#put-provisioning-policy) | **Put** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype +[**put-source**](#put-source) | **Put** `/sources/{id}` | Update source (full) +[**put-source-schema**](#put-source-schema) | **Put** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (full) +[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **Post** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies +[**update-provisioning-policy**](#update-provisioning-policy) | **Patch** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy +[**update-source**](#update-source) | **Patch** `/sources/{id}` | Update source (partial) +[**update-source-schema**](#update-source-schema) | **Patch** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (partial) ## create-provisioning-policy -Create Provisioning Policy +Create provisioning policy This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. @@ -215,7 +215,7 @@ func main() { [[Back to top]](#) ## create-source -Creates a source in IdentityNow. +Creates a source in identitynow. This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-source) @@ -366,7 +366,7 @@ func main() { [[Back to top]](#) ## create-source-schema -Create Schema on Source +Create schema on source Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). @@ -473,7 +473,7 @@ func main() { [[Back to top]](#) ## delete-provisioning-policy -Delete Provisioning Policy by UsageType +Delete provisioning policy by usagetype Deletes the provisioning policy with the specified usage on an application. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-provisioning-policy) @@ -541,7 +541,7 @@ func main() { [[Back to top]](#) ## delete-source -Delete Source by ID +Delete source by id Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` @@ -608,7 +608,7 @@ func main() { [[Back to top]](#) ## delete-source-schema -Delete Source Schema by ID +Delete source schema by id [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-source-schema) @@ -811,7 +811,7 @@ func main() { [[Back to top]](#) ## get-provisioning-policy -Get Provisioning Policy by UsageType +Get provisioning policy by usagetype This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-provisioning-policy) @@ -880,7 +880,7 @@ func main() { [[Back to top]](#) ## get-source -Get Source by ID +Get source by id Use this API to get a source by a specified ID in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/v3/get-source) @@ -946,7 +946,7 @@ func main() { [[Back to top]](#) ## get-source-connections -Get Source Connections by ID +Get source connections by id Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-connections) @@ -1078,7 +1078,7 @@ func main() { [[Back to top]](#) ## get-source-schema -Get Source Schema by ID +Get source schema by id Get the Source Schema by ID in IdentityNow. @@ -1148,7 +1148,7 @@ func main() { [[Back to top]](#) ## get-source-schemas -List Schemas on Source +List schemas on source Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). [API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-schemas) @@ -1436,7 +1436,7 @@ func main() { [[Back to top]](#) ## list-provisioning-policies -Lists ProvisioningPolicies +Lists provisioningpolicies This end-point lists all the ProvisioningPolicies in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-provisioning-policies) @@ -1502,7 +1502,7 @@ func main() { [[Back to top]](#) ## list-sources -Lists all sources in IdentityNow. +Lists all sources in identitynow. This end-point lists all the sources in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-sources) @@ -1576,7 +1576,7 @@ func main() { [[Back to top]](#) ## put-provisioning-policy -Update Provisioning Policy by UsageType +Update provisioning policy by usagetype This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. @@ -1693,7 +1693,7 @@ func main() { [[Back to top]](#) ## put-source -Update Source (Full) +Update source (full) Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: @@ -1860,7 +1860,7 @@ func main() { [[Back to top]](#) ## put-source-schema -Update Source Schema (Full) +Update source schema (full) This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id @@ -1979,7 +1979,7 @@ func main() { [[Back to top]](#) ## update-provisioning-policies-in-bulk -Bulk Update Provisioning Policies +Bulk update provisioning policies This end-point updates a list of provisioning policies on the specified source in IdentityNow. [API Spec](https://developer.sailpoint.com/docs/api/v3/update-provisioning-policies-in-bulk) @@ -2052,7 +2052,7 @@ func main() { [[Back to top]](#) ## update-provisioning-policy -Partial update of Provisioning Policy +Partial update of provisioning policy This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. @@ -2130,7 +2130,7 @@ func main() { [[Back to top]](#) ## update-source -Update Source (Partial) +Update source (partial) Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. @@ -2218,7 +2218,7 @@ func main() { [[Back to top]](#) ## update-source-schema -Update Source Schema (Partial) +Update source schema (partial) Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: diff --git a/docs/tools/sdk/go/Reference/V3/Methods/TaggedObjectsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/TaggedObjectsAPI.md index 403d871f7..92cbe2ca7 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/TaggedObjectsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/TaggedObjectsAPI.md @@ -68,18 +68,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**delete-tagged-object**](#delete-tagged-object) | **Delete** `/tagged-objects/{type}/{id}` | Delete Object Tags -[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **Post** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects -[**get-tagged-object**](#get-tagged-object) | **Get** `/tagged-objects/{type}/{id}` | Get Tagged Object -[**list-tagged-objects**](#list-tagged-objects) | **Get** `/tagged-objects` | List Tagged Objects -[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **Get** `/tagged-objects/{type}` | List Tagged Objects by Type -[**put-tagged-object**](#put-tagged-object) | **Put** `/tagged-objects/{type}/{id}` | Update Tagged Object -[**set-tag-to-object**](#set-tag-to-object) | **Post** `/tagged-objects` | Add Tag to Object -[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **Post** `/tagged-objects/bulk-add` | Tag Multiple Objects +[**delete-tagged-object**](#delete-tagged-object) | **Delete** `/tagged-objects/{type}/{id}` | Delete object tags +[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **Post** `/tagged-objects/bulk-remove` | Remove tags from multiple objects +[**get-tagged-object**](#get-tagged-object) | **Get** `/tagged-objects/{type}/{id}` | Get tagged object +[**list-tagged-objects**](#list-tagged-objects) | **Get** `/tagged-objects` | List tagged objects +[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **Get** `/tagged-objects/{type}` | List tagged objects by type +[**put-tagged-object**](#put-tagged-object) | **Put** `/tagged-objects/{type}/{id}` | Update tagged object +[**set-tag-to-object**](#set-tag-to-object) | **Post** `/tagged-objects` | Add tag to object +[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **Post** `/tagged-objects/bulk-add` | Tag multiple objects ## delete-tagged-object -Delete Object Tags +Delete object tags Delete all tags from a tagged object. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-tagged-object) @@ -147,7 +147,7 @@ func main() { [[Back to top]](#) ## delete-tags-to-many-object -Remove Tags from Multiple Objects +Remove tags from multiple objects This API removes tags from multiple objects. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-tags-to-many-object) @@ -224,7 +224,7 @@ func main() { [[Back to top]](#) ## get-tagged-object -Get Tagged Object +Get tagged object This gets a tagged object for the specified type. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-tagged-object) @@ -293,7 +293,7 @@ func main() { [[Back to top]](#) ## list-tagged-objects -List Tagged Objects +List tagged objects This API returns a list of all tagged objects. Any authenticated token may be used to call this API. @@ -363,7 +363,7 @@ func main() { [[Back to top]](#) ## list-tagged-objects-by-type -List Tagged Objects by Type +List tagged objects by type This API returns a list of all tagged objects by type. Any authenticated token may be used to call this API. @@ -439,7 +439,7 @@ func main() { [[Back to top]](#) ## put-tagged-object -Update Tagged Object +Update tagged object This updates a tagged object for the specified type. [API Spec](https://developer.sailpoint.com/docs/api/v3/put-tagged-object) @@ -522,7 +522,7 @@ func main() { [[Back to top]](#) ## set-tag-to-object -Add Tag to Object +Add tag to object This adds a tag to an object. Any authenticated token may be used to call this API. @@ -597,7 +597,7 @@ func main() { [[Back to top]](#) ## set-tags-to-many-objects -Tag Multiple Objects +Tag multiple objects This API adds tags to multiple objects. [API Spec](https://developer.sailpoint.com/docs/api/v3/set-tags-to-many-objects) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/TransformsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/TransformsAPI.md index e46826b2f..5160963ba 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/TransformsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/TransformsAPI.md @@ -22,7 +22,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create-transform**](#create-transform) | **Post** `/transforms` | Create transform [**delete-transform**](#delete-transform) | **Delete** `/transforms/{id}` | Delete a transform -[**get-transform**](#get-transform) | **Get** `/transforms/{id}` | Transform by ID +[**get-transform**](#get-transform) | **Get** `/transforms/{id}` | Transform by id [**list-transforms**](#list-transforms) | **Get** `/transforms` | List transforms [**update-transform**](#update-transform) | **Put** `/transforms/{id}` | Update a transform @@ -164,7 +164,7 @@ func main() { [[Back to top]](#) ## get-transform -Transform by ID +Transform by id This API returns the transform specified by the given ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-transform) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/VendorConnectorMappingsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/VendorConnectorMappingsAPI.md index ff4f2751a..d960193cd 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/VendorConnectorMappingsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/VendorConnectorMappingsAPI.md @@ -15,13 +15,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **Post** `/vendor-connector-mappings` | Create Vendor Connector Mapping -[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **Delete** `/vendor-connector-mappings` | Delete Vendor Connector Mapping -[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **Get** `/vendor-connector-mappings` | List Vendor Connector Mappings +[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **Post** `/vendor-connector-mappings` | Create vendor connector mapping +[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **Delete** `/vendor-connector-mappings` | Delete vendor connector mapping +[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **Get** `/vendor-connector-mappings` | List vendor connector mappings ## create-vendor-connector-mapping -Create Vendor Connector Mapping +Create vendor connector mapping Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. @@ -111,7 +111,7 @@ func main() { [[Back to top]](#) ## delete-vendor-connector-mapping -Delete Vendor Connector Mapping +Delete vendor connector mapping Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. @@ -201,7 +201,7 @@ func main() { [[Back to top]](#) ## get-vendor-connector-mappings -List Vendor Connector Mappings +List vendor connector mappings Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. diff --git a/docs/tools/sdk/go/Reference/V3/Methods/WorkItemsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/WorkItemsAPI.md index ee692f106..c657921d5 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/WorkItemsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/WorkItemsAPI.md @@ -29,23 +29,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve-approval-item**](#approve-approval-item) | **Post** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item -[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **Post** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items -[**complete-work-item**](#complete-work-item) | **Post** `/work-items/{id}` | Complete a Work Item -[**get-completed-work-items**](#get-completed-work-items) | **Get** `/work-items/completed` | Completed Work Items -[**get-count-completed-work-items**](#get-count-completed-work-items) | **Get** `/work-items/completed/count` | Count Completed Work Items -[**get-count-work-items**](#get-count-work-items) | **Get** `/work-items/count` | Count Work Items -[**get-work-item**](#get-work-item) | **Get** `/work-items/{id}` | Get a Work Item -[**get-work-items-summary**](#get-work-items-summary) | **Get** `/work-items/summary` | Work Items Summary -[**list-work-items**](#list-work-items) | **Get** `/work-items` | List Work Items -[**reject-approval-item**](#reject-approval-item) | **Post** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item -[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **Post** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items -[**send-work-item-forward**](#send-work-item-forward) | **Post** `/work-items/{id}/forward` | Forward a Work Item -[**submit-account-selection**](#submit-account-selection) | **Post** `/work-items/{id}/submit-account-selection` | Submit Account Selections +[**approve-approval-item**](#approve-approval-item) | **Post** `/work-items/{id}/approve/{approvalItemId}` | Approve an approval item +[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **Post** `/work-items/bulk-approve/{id}` | Bulk approve approval items +[**complete-work-item**](#complete-work-item) | **Post** `/work-items/{id}` | Complete a work item +[**get-completed-work-items**](#get-completed-work-items) | **Get** `/work-items/completed` | Completed work items +[**get-count-completed-work-items**](#get-count-completed-work-items) | **Get** `/work-items/completed/count` | Count completed work items +[**get-count-work-items**](#get-count-work-items) | **Get** `/work-items/count` | Count work items +[**get-work-item**](#get-work-item) | **Get** `/work-items/{id}` | Get a work item +[**get-work-items-summary**](#get-work-items-summary) | **Get** `/work-items/summary` | Work items summary +[**list-work-items**](#list-work-items) | **Get** `/work-items` | List work items +[**reject-approval-item**](#reject-approval-item) | **Post** `/work-items/{id}/reject/{approvalItemId}` | Reject an approval item +[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **Post** `/work-items/bulk-reject/{id}` | Bulk reject approval items +[**send-work-item-forward**](#send-work-item-forward) | **Post** `/work-items/{id}/forward` | Forward a work item +[**submit-account-selection**](#submit-account-selection) | **Post** `/work-items/{id}/submit-account-selection` | Submit account selections ## approve-approval-item -Approve an Approval Item +Approve an approval item This API approves an Approval Item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-item) @@ -114,7 +114,7 @@ func main() { [[Back to top]](#) ## approve-approval-items-in-bulk -Bulk approve Approval Items +Bulk approve approval items This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-items-in-bulk) @@ -180,7 +180,7 @@ func main() { [[Back to top]](#) ## complete-work-item -Complete a Work Item +Complete a work item This API completes a work item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v3/complete-work-item) @@ -248,7 +248,7 @@ func main() { [[Back to top]](#) ## get-completed-work-items -Completed Work Items +Completed work items This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-completed-work-items) @@ -316,7 +316,7 @@ func main() { [[Back to top]](#) ## get-count-completed-work-items -Count Completed Work Items +Count completed work items This gets a count of completed work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-completed-work-items) @@ -378,7 +378,7 @@ func main() { [[Back to top]](#) ## get-count-work-items -Count Work Items +Count work items This gets a count of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-work-items) @@ -440,7 +440,7 @@ func main() { [[Back to top]](#) ## get-work-item -Get a Work Item +Get a work item This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-item) @@ -506,7 +506,7 @@ func main() { [[Back to top]](#) ## get-work-items-summary -Work Items Summary +Work items summary This gets a summary of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-items-summary) @@ -568,7 +568,7 @@ func main() { [[Back to top]](#) ## list-work-items -List Work Items +List work items This gets a collection of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-work-items) @@ -636,7 +636,7 @@ func main() { [[Back to top]](#) ## reject-approval-item -Reject an Approval Item +Reject an approval item This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-item) @@ -705,7 +705,7 @@ func main() { [[Back to top]](#) ## reject-approval-items-in-bulk -Bulk reject Approval Items +Bulk reject approval items This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-items-in-bulk) @@ -771,7 +771,7 @@ func main() { [[Back to top]](#) ## send-work-item-forward -Forward a Work Item +Forward a work item This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN. [API Spec](https://developer.sailpoint.com/docs/api/v3/send-work-item-forward) @@ -847,7 +847,7 @@ func main() { [[Back to top]](#) ## submit-account-selection -Submit Account Selections +Submit account selections This API submits account selections. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/v3/submit-account-selection) diff --git a/docs/tools/sdk/go/Reference/V3/Methods/WorkflowsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/WorkflowsAPI.md index b79c9a0ad..d720114d1 100644 --- a/docs/tools/sdk/go/Reference/V3/Methods/WorkflowsAPI.md +++ b/docs/tools/sdk/go/Reference/V3/Methods/WorkflowsAPI.md @@ -16,28 +16,28 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**cancel-workflow-execution**](#cancel-workflow-execution) | **Post** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID -[**create-external-execute-workflow**](#create-external-execute-workflow) | **Post** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger -[**create-workflow**](#create-workflow) | **Post** `/workflows` | Create Workflow -[**create-workflow-external-trigger**](#create-workflow-external-trigger) | **Post** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client -[**delete-workflow**](#delete-workflow) | **Delete** `/workflows/{id}` | Delete Workflow By Id -[**get-workflow**](#get-workflow) | **Get** `/workflows/{id}` | Get Workflow By Id -[**get-workflow-execution**](#get-workflow-execution) | **Get** `/workflow-executions/{id}` | Get Workflow Execution -[**get-workflow-execution-history**](#get-workflow-execution-history) | **Get** `/workflow-executions/{id}/history` | Get Workflow Execution History -[**get-workflow-executions**](#get-workflow-executions) | **Get** `/workflows/{id}/executions` | List Workflow Executions -[**list-complete-workflow-library**](#list-complete-workflow-library) | **Get** `/workflow-library` | List Complete Workflow Library -[**list-workflow-library-actions**](#list-workflow-library-actions) | **Get** `/workflow-library/actions` | List Workflow Library Actions -[**list-workflow-library-operators**](#list-workflow-library-operators) | **Get** `/workflow-library/operators` | List Workflow Library Operators -[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **Get** `/workflow-library/triggers` | List Workflow Library Triggers -[**list-workflows**](#list-workflows) | **Get** `/workflows` | List Workflows -[**patch-workflow**](#patch-workflow) | **Patch** `/workflows/{id}` | Patch Workflow -[**put-workflow**](#put-workflow) | **Put** `/workflows/{id}` | Update Workflow -[**test-external-execute-workflow**](#test-external-execute-workflow) | **Post** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger -[**test-workflow**](#test-workflow) | **Post** `/workflows/{id}/test` | Test Workflow By Id +[**cancel-workflow-execution**](#cancel-workflow-execution) | **Post** `/workflow-executions/{id}/cancel` | Cancel workflow execution by id +[**create-external-execute-workflow**](#create-external-execute-workflow) | **Post** `/workflows/execute/external/{id}` | Execute workflow via external trigger +[**create-workflow**](#create-workflow) | **Post** `/workflows` | Create workflow +[**create-workflow-external-trigger**](#create-workflow-external-trigger) | **Post** `/workflows/{id}/external/oauth-clients` | Generate external trigger oauth client +[**delete-workflow**](#delete-workflow) | **Delete** `/workflows/{id}` | Delete workflow by id +[**get-workflow**](#get-workflow) | **Get** `/workflows/{id}` | Get workflow by id +[**get-workflow-execution**](#get-workflow-execution) | **Get** `/workflow-executions/{id}` | Get workflow execution +[**get-workflow-execution-history**](#get-workflow-execution-history) | **Get** `/workflow-executions/{id}/history` | Get workflow execution history +[**get-workflow-executions**](#get-workflow-executions) | **Get** `/workflows/{id}/executions` | List workflow executions +[**list-complete-workflow-library**](#list-complete-workflow-library) | **Get** `/workflow-library` | List complete workflow library +[**list-workflow-library-actions**](#list-workflow-library-actions) | **Get** `/workflow-library/actions` | List workflow library actions +[**list-workflow-library-operators**](#list-workflow-library-operators) | **Get** `/workflow-library/operators` | List workflow library operators +[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **Get** `/workflow-library/triggers` | List workflow library triggers +[**list-workflows**](#list-workflows) | **Get** `/workflows` | List workflows +[**patch-workflow**](#patch-workflow) | **Patch** `/workflows/{id}` | Patch workflow +[**put-workflow**](#put-workflow) | **Put** `/workflows/{id}` | Update workflow +[**test-external-execute-workflow**](#test-external-execute-workflow) | **Post** `/workflows/execute/external/{id}/test` | Test workflow via external trigger +[**test-workflow**](#test-workflow) | **Post** `/workflows/{id}/test` | Test workflow by id ## cancel-workflow-execution -Cancel Workflow Execution by ID +Cancel workflow execution by id Use this API to cancel a running workflow execution. [API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-workflow-execution) @@ -102,7 +102,7 @@ func main() { [[Back to top]](#) ## create-external-execute-workflow -Execute Workflow via External Trigger +Execute workflow via external trigger This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-external-execute-workflow) @@ -170,7 +170,7 @@ func main() { [[Back to top]](#) ## create-workflow -Create Workflow +Create workflow Create a new workflow with the desired trigger and steps specified in the request body. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-workflow) @@ -237,7 +237,7 @@ func main() { [[Back to top]](#) ## create-workflow-external-trigger -Generate External Trigger OAuth Client +Generate external trigger oauth client Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-workflow-external-trigger) @@ -303,7 +303,7 @@ func main() { [[Back to top]](#) ## delete-workflow -Delete Workflow By Id +Delete workflow by id Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-workflow) @@ -368,7 +368,7 @@ func main() { [[Back to top]](#) ## get-workflow -Get Workflow By Id +Get workflow by id Get a single workflow by id. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow) @@ -436,7 +436,7 @@ func main() { [[Back to top]](#) ## get-workflow-execution -Get Workflow Execution +Get workflow execution Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution) @@ -502,7 +502,7 @@ func main() { [[Back to top]](#) ## get-workflow-execution-history -Get Workflow Execution History +Get workflow execution history Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution-history) @@ -568,7 +568,7 @@ func main() { [[Back to top]](#) ## get-workflow-executions -List Workflow Executions +List workflow executions Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. @@ -652,7 +652,7 @@ func main() { [[Back to top]](#) ## list-complete-workflow-library -List Complete Workflow Library +List complete workflow library This lists all triggers, actions, and operators in the library [API Spec](https://developer.sailpoint.com/docs/api/v3/list-complete-workflow-library) @@ -716,7 +716,7 @@ func main() { [[Back to top]](#) ## list-workflow-library-actions -List Workflow Library Actions +List workflow library actions This lists the workflow actions available to you. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-actions) @@ -782,7 +782,7 @@ func main() { [[Back to top]](#) ## list-workflow-library-operators -List Workflow Library Operators +List workflow library operators This lists the workflow operators available to you [API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-operators) @@ -839,7 +839,7 @@ func main() { [[Back to top]](#) ## list-workflow-library-triggers -List Workflow Library Triggers +List workflow library triggers This lists the workflow triggers available to you [API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-triggers) @@ -905,7 +905,7 @@ func main() { [[Back to top]](#) ## list-workflows -List Workflows +List workflows List all workflows in the tenant. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflows) @@ -973,7 +973,7 @@ func main() { [[Back to top]](#) ## patch-workflow -Patch Workflow +Patch workflow Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. [API Spec](https://developer.sailpoint.com/docs/api/v3/patch-workflow) @@ -1046,7 +1046,7 @@ func main() { [[Back to top]](#) ## put-workflow -Update Workflow +Update workflow Perform a full update of a workflow. The updated workflow object is returned in the response. [API Spec](https://developer.sailpoint.com/docs/api/v3/put-workflow) @@ -1152,7 +1152,7 @@ func main() { [[Back to top]](#) ## test-external-execute-workflow -Test Workflow via External Trigger +Test workflow via external trigger Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. [API Spec](https://developer.sailpoint.com/docs/api/v3/test-external-execute-workflow) @@ -1220,7 +1220,7 @@ func main() { [[Back to top]](#) ## test-workflow -Test Workflow By Id +Test workflow by id :::info Workflow must be disabled in order to use this endpoint.