LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Go SDK docs: 16205722495

Browse Source
This commit is contained in:
developer-relations-sp
2025-07-10 20:51:08 +00:00
parent 63d156bb2f
commit f785aaaf50
17 changed files with 768 additions and 690 deletions
Download Patch File Download Diff File Expand all files Collapse all files

552
docs/tools/sdk/go/Reference/Beta/Methods/NonEmployeeLifecycleManagementAPI.md
View File

@@ -57,11 +57,11 @@ Method | HTTP request | Description
[**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
[**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**](#get-non-employee-approval) | **Get** `/non-employee-approvals/{id}` | A non-employee approval item detail
[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **Get** `/non-employee-approvals/summary/{requested-for}` | 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-export-records**](#get-non-employee-export-records) | **Get** `/non-employee-sources/{id}/non-employees/download` | Exports non-employee records to csv
[**get-non-employee-export-source-schema-template**](#get-non-employee-export-source-schema-template) | **Get** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports source schema template
[**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
@@ -69,18 +69,21 @@ Method | HTTP request | Description
[**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-approval**](#list-non-employee-approval) | **Get** `/non-employee-approvals` | 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
[**put-non-employee-record**](#put-non-employee-record) | **Put** `/non-employee-records/{id}` | Update non-employee record
[**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
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Approve a non-employee request
Approves a non-employee approval request and notifies the next approver.
@@ -128,7 +131,7 @@ import (
)
func main() {
id := `id_example` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID)
id := `2c91808b6ef1d43e016efba0ce470904` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID)
nonemployeeapprovaldecision := []byte(`{
"comment" : "comment"
}`) // NonEmployeeApprovalDecision |
@@ -156,6 +159,9 @@ func main() {
[[Back to top]](#)
## create-non-employee-record
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Create non-employee record
This request will create a non-employee record.
Request will require the following security scope:
@@ -239,6 +245,9 @@ func main() {
[[Back to top]](#)
## create-non-employee-request
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Create non-employee request
This request will create a non-employee request and notify the approver
@@ -320,6 +329,9 @@ func main() {
[[Back to top]](#)
## create-non-employee-source
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Create non-employee source
Create a non-employee source.
@@ -412,6 +424,9 @@ func main() {
[[Back to top]](#)
## create-non-employee-source-schema-attributes
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
@@ -492,6 +507,9 @@ func main() {
[[Back to top]](#)
## delete-non-employee-record
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete non-employee record
This request will delete a non-employee record.
@@ -557,6 +575,9 @@ func main() {
[[Back to top]](#)
## delete-non-employee-record-in-bulk
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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:
@@ -625,6 +646,9 @@ func main() {
[[Back to top]](#)
## delete-non-employee-request
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete non-employee request
This request will delete a non-employee request.
@@ -690,6 +714,9 @@ func main() {
[[Back to top]](#)
## delete-non-employee-schema-attribute
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete non-employee source's schema attribute
This end-point deletes a specific schema attribute for a non-employee source.
@@ -759,6 +786,9 @@ func main() {
[[Back to top]](#)
## delete-non-employee-source
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete non-employee source
This request will delete a non-employee source.
@@ -824,6 +854,9 @@ func main() {
[[Back to top]](#)
## delete-non-employee-source-schema-attributes
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete all custom schema attributes
This end-point deletes all custom schema attributes for a non-employee source.
@@ -888,140 +921,11 @@ func main() {
[[Back to top]](#)
## export-non-employee-records
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)
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | Source Id (UUID) |
### Other Parameters
Other parameters are passed through a pointer to a apiExportNonEmployeeRecordsRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
(empty response body)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/csv, application/json
### Example
```go
package main
import (
"context"
"fmt"
"os"
sailpoint "github.com/sailpoint-oss/golang-sdk/v2"
)
func main() {
id := `2c918085842e69ae018432d22ccb212f` // string | Source Id (UUID) # string | Source Id (UUID)
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeRecords(context.Background(), id).Execute()
//r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeRecords(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ExportNonEmployeeRecords``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
[[Back to top]](#)
## export-non-employee-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'
[API Spec](https://developer.sailpoint.com/docs/api/beta/export-non-employee-source-schema-template)
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | Source Id (UUID) |
### Other Parameters
Other parameters are passed through a pointer to a apiExportNonEmployeeSourceSchemaTemplateRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
(empty response body)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/csv, application/json
### Example
```go
package main
import (
"context"
"fmt"
"os"
sailpoint "github.com/sailpoint-oss/golang-sdk/v2"
)
func main() {
id := `2c918085842e69ae018432d22ccb212f` // string | Source Id (UUID) # string | Source Id (UUID)
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeSourceSchemaTemplate(context.Background(), id).Execute()
//r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeSourceSchemaTemplate(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ExportNonEmployeeSourceSchemaTemplate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
[[Back to top]](#)
## get-non-employee-approval
Get a non-employee approval item detail
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
A non-employee approval item detail
Approves a non-employee approval request and notifies the next approver.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-approval)
@@ -1089,7 +993,10 @@ func main() {
[[Back to top]](#)
## get-non-employee-approval-summary
Get summary of non-employee approval requests
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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)
@@ -1155,6 +1062,9 @@ func main() {
[[Back to top]](#)
## get-non-employee-bulk-upload-status
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Bulk upload status on source
The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source.
@@ -1221,7 +1131,148 @@ func main() {
[[Back to top]](#)
## get-non-employee-export-records
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/get-non-employee-export-records)
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | Source Id (UUID) |
### Other Parameters
Other parameters are passed through a pointer to a apiGetNonEmployeeExportRecordsRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
(empty response body)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/csv, application/json
### Example
```go
package main
import (
"context"
"fmt"
"os"
sailpoint "github.com/sailpoint-oss/golang-sdk/v2"
)
func main() {
id := `2c918085842e69ae018432d22ccb212f` // string | Source Id (UUID) # string | Source Id (UUID)
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeExportRecords(context.Background(), id).Execute()
//r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeExportRecords(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeExportRecords``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
[[Back to top]](#)
## get-non-employee-export-source-schema-template
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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'
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-export-source-schema-template)
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | Source Id (UUID) |
### Other Parameters
Other parameters are passed through a pointer to a apiGetNonEmployeeExportSourceSchemaTemplateRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
(empty response body)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/csv, application/json
### Example
```go
package main
import (
"context"
"fmt"
"os"
sailpoint "github.com/sailpoint-oss/golang-sdk/v2"
)
func main() {
id := `2c918085842e69ae018432d22ccb212f` // string | Source Id (UUID) # string | Source Id (UUID)
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeExportSourceSchemaTemplate(context.Background(), id).Execute()
//r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeExportSourceSchemaTemplate(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeExportSourceSchemaTemplate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
[[Back to top]](#)
## get-non-employee-record
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get a non-employee record
This gets a non-employee record.
@@ -1288,6 +1339,9 @@ func main() {
[[Back to top]](#)
## get-non-employee-request
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get a non-employee request
This gets a non-employee request.
@@ -1354,6 +1408,9 @@ func main() {
[[Back to top]](#)
## get-non-employee-request-summary
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
@@ -1420,6 +1477,9 @@ func main() {
[[Back to top]](#)
## get-non-employee-schema-attribute
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get schema attribute non-employee source
This API gets a schema attribute by Id for the specified Non-Employee SourceId.
@@ -1489,6 +1549,9 @@ func main() {
[[Back to top]](#)
## get-non-employee-source
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get a non-employee source
This gets a non-employee source.
@@ -1555,6 +1618,9 @@ func main() {
[[Back to top]](#)
## get-non-employee-source-schema-attributes
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
@@ -1576,6 +1642,8 @@ Other parameters are passed through a pointer to a apiGetNonEmployeeSourceSchema
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **int32** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 250]
**offset** | **int32** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 0]
### Return type
@@ -1602,13 +1670,15 @@ import (
func main() {
sourceId := `2c918085842e69ae018432d22ccb212f` // string | The Source id # string | The Source id
limit := 250 // int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
offset := 0 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute()
//resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute()
//resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Limit(limit).Offset(offset).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -1621,6 +1691,9 @@ func main() {
[[Back to top]](#)
## import-non-employee-records-in-bulk
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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:
@@ -1691,7 +1764,10 @@ func main() {
[[Back to top]](#)
## list-non-employee-approval
Get list of non-employee approval requests
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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,6 +1839,9 @@ func main() {
[[Back to top]](#)
## list-non-employee-records
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
List non-employee records
This gets a list of non-employee records.
@@ -1833,6 +1912,9 @@ func main() {
[[Back to top]](#)
## list-non-employee-requests
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
List non-employee requests
This gets a list of non-employee requests.
@@ -1905,6 +1987,9 @@ func main() {
[[Back to top]](#)
## list-non-employee-sources
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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`.
@@ -1979,6 +2064,9 @@ func main() {
[[Back to top]](#)
## patch-non-employee-record
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Patch non-employee record
This request will patch a non-employee record.
@@ -2052,6 +2140,9 @@ func main() {
[[Back to top]](#)
## patch-non-employee-schema-attribute
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Patch non-employee source's schema attribute
This end-point patches a specific schema attribute for a non-employee SourceId.
@@ -2129,6 +2220,9 @@ func main() {
[[Back to top]](#)
## patch-non-employee-source
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Patch a non-employee source
patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers**
@@ -2201,86 +2295,14 @@ func main() {
[[Back to top]](#)
## reject-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)
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | Non-Employee approval item id (UUID) |
### Other Parameters
Other parameters are passed through a pointer to a apiRejectNonEmployeeRequestRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**nonEmployeeRejectApprovalDecision** | [**NonEmployeeRejectApprovalDecision**](../models/non-employee-reject-approval-decision) | |
### Return type
[**NonEmployeeApprovalItem**](../models/non-employee-approval-item)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```go
package main
import (
"context"
"fmt"
"os"
"encoding/json"
beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta"
sailpoint "github.com/sailpoint-oss/golang-sdk/v2"
)
func main() {
id := `id_example` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID)
nonemployeerejectapprovaldecision := []byte(`{
"comment" : "comment"
}`) // NonEmployeeRejectApprovalDecision |
var nonEmployeeRejectApprovalDecision beta.NonEmployeeRejectApprovalDecision
if err := json.Unmarshal(nonemployeerejectapprovaldecision, &nonEmployeeRejectApprovalDecision); err != nil {
fmt.Println("Error:", err)
return
}
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest(context.Background(), id).NonEmployeeRejectApprovalDecision(nonEmployeeRejectApprovalDecision).Execute()
//resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest(context.Background(), id).NonEmployeeRejectApprovalDecision(nonEmployeeRejectApprovalDecision).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `RejectNonEmployeeRequest`: NonEmployeeApprovalItem
fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest`: %v\n", resp)
}
```
[[Back to top]](#)
## update-non-employee-record
## put-non-employee-record
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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)
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-non-employee-record)
### Path Parameters
@@ -2292,7 +2314,7 @@ Name | Type | Description | Notes
### Other Parameters
Other parameters are passed through a pointer to a apiUpdateNonEmployeeRecordRequest struct via the builder pattern
Other parameters are passed through a pointer to a apiPutNonEmployeeRecordRequest struct via the builder pattern
Name | Type | Description | Notes
@@ -2350,14 +2372,92 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(context.Background(), id).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute()
//resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(context.Background(), id).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute()
resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PutNonEmployeeRecord(context.Background(), id).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute()
//resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PutNonEmployeeRecord(context.Background(), id).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord``: %v\n", err)
fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PutNonEmployeeRecord``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateNonEmployeeRecord`: NonEmployeeRecord
fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord`: %v\n", resp)
// response from `PutNonEmployeeRecord`: NonEmployeeRecord
fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PutNonEmployeeRecord`: %v\n", resp)
}
```
[[Back to top]](#)
## reject-non-employee-request
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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)
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | Non-Employee approval item id (UUID) |
### Other Parameters
Other parameters are passed through a pointer to a apiRejectNonEmployeeRequestRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**nonEmployeeRejectApprovalDecision** | [**NonEmployeeRejectApprovalDecision**](../models/non-employee-reject-approval-decision) | |
### Return type
[**NonEmployeeApprovalItem**](../models/non-employee-approval-item)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```go
package main
import (
"context"
"fmt"
"os"
"encoding/json"
beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta"
sailpoint "github.com/sailpoint-oss/golang-sdk/v2"
)
func main() {
id := `2c91808b6ef1d43e016efba0ce470904` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID)
nonemployeerejectapprovaldecision := []byte(`{
"comment" : "comment"
}`) // NonEmployeeRejectApprovalDecision |
var nonEmployeeRejectApprovalDecision beta.NonEmployeeRejectApprovalDecision
if err := json.Unmarshal(nonemployeerejectapprovaldecision, &nonEmployeeRejectApprovalDecision); err != nil {
fmt.Println("Error:", err)
return
}
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest(context.Background(), id).NonEmployeeRejectApprovalDecision(nonEmployeeRejectApprovalDecision).Execute()
//resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest(context.Background(), id).NonEmployeeRejectApprovalDecision(nonEmployeeRejectApprovalDecision).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `RejectNonEmployeeRequest`: NonEmployeeApprovalItem
fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest`: %v\n", resp)
}
```

12
docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeBulkUploadStatus.md
View File

@@ -15,7 +15,7 @@ tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadStatus', 'BetaNo
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Status** | Pointer to **string** | Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. null means job has been submitted to the source. | [optional]
**Status** | Pointer to **NullableString** | Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. null means job has been submitted to the source. | [optional]
## Methods
@@ -61,4 +61,14 @@ SetStatus sets Status field to given value.
HasStatus returns a boolean if a field has been set.
### SetStatusNil
`func (o *NonEmployeeBulkUploadStatus) SetStatusNil(b bool)`
SetStatusNil sets the value for Status to be an explicit nil
### UnsetStatus
`func (o *NonEmployeeBulkUploadStatus) UnsetStatus()`
UnsetStatus ensures that no value is present for Status, not even an explicit nil

24
docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSchemaAttribute.md
View File

@@ -22,8 +22,8 @@ Name | Type | Description | Notes
**Type** | [**NonEmployeeSchemaAttributeType**](non-employee-schema-attribute-type) | |
**Label** | **string** | Label displayed on the UI for this schema attribute. |
**TechnicalName** | **string** | The technical name of the attribute. Must be unique per source. |
**HelpText** | Pointer to **string** | help text displayed by UI. | [optional]
**Placeholder** | Pointer to **string** | Hint text that fills UI box. | [optional]
**HelpText** | Pointer to **NullableString** | help text displayed by UI. | [optional]
**Placeholder** | Pointer to **NullableString** | Hint text that fills UI box. | [optional]
**Required** | Pointer to **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] [default to false]
## Methods
@@ -230,6 +230,16 @@ SetHelpText sets HelpText field to given value.
HasHelpText returns a boolean if a field has been set.
### SetHelpTextNil
`func (o *NonEmployeeSchemaAttribute) SetHelpTextNil(b bool)`
SetHelpTextNil sets the value for HelpText to be an explicit nil
### UnsetHelpText
`func (o *NonEmployeeSchemaAttribute) UnsetHelpText()`
UnsetHelpText ensures that no value is present for HelpText, not even an explicit nil
### GetPlaceholder
`func (o *NonEmployeeSchemaAttribute) GetPlaceholder() string`
@@ -255,6 +265,16 @@ SetPlaceholder sets Placeholder field to given value.
HasPlaceholder returns a boolean if a field has been set.
### SetPlaceholderNil
`func (o *NonEmployeeSchemaAttribute) SetPlaceholderNil(b bool)`
SetPlaceholderNil sets the value for Placeholder to be an explicit nil
### UnsetPlaceholder
`func (o *NonEmployeeSchemaAttribute) UnsetPlaceholder()`
UnsetPlaceholder ensures that no value is present for Placeholder, not even an explicit nil
### GetRequired
`func (o *NonEmployeeSchemaAttribute) GetRequired() bool`

4
docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSchemaAttributeType.md
View File

@@ -20,4 +20,8 @@ tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeType', 'Bet
* `IDENTITY` (value: `"IDENTITY"`)
* `PHONE` (value: `"PHONE"`)
* `EMAIL` (value: `"EMAIL"`)

17
docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestsAPI.md
View File

@@ -255,17 +255,6 @@ func main() {
[[Back to top]](#)
## close-access-request
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
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/).
@@ -293,7 +282,6 @@ Other parameters are passed through a pointer to a apiCloseAccessRequestRequest
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**closeAccessRequest** | [**CloseAccessRequest**](../models/close-access-request) | |
### Return type
@@ -320,7 +308,6 @@ import (
)
func main() {
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
closeaccessrequest := []byte(`{
"executionStatus" : "Terminated",
"accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
@@ -337,8 +324,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.AccessRequestsAPI.CloseAccessRequest(context.Background()).XSailPointExperimental(xSailPointExperimental).CloseAccessRequest(closeAccessRequest).Execute()
//resp, r, err := apiClient.V2024.AccessRequestsAPI.CloseAccessRequest(context.Background()).XSailPointExperimental(xSailPointExperimental).CloseAccessRequest(closeAccessRequest).Execute()
resp, r, err := apiClient.V2024.AccessRequestsAPI.CloseAccessRequest(context.Background()).CloseAccessRequest(closeAccessRequest).Execute()
//resp, r, err := apiClient.V2024.AccessRequestsAPI.CloseAccessRequest(context.Background()).CloseAccessRequest(closeAccessRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CloseAccessRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)

17
docs/tools/sdk/go/Reference/V2024/Methods/AccountAggregationsAPI.md
View File

@@ -29,17 +29,6 @@ Method | HTTP request | Description
## get-account-aggregation-status
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
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.
@@ -68,7 +57,6 @@ Other parameters are passed through a pointer to a apiGetAccountAggregationStatu
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -95,14 +83,13 @@ import (
func main() {
id := `2c91808477a6b0c60177a81146b8110b` // string | The account aggregation id # string | The account aggregation id
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.AccountAggregationsAPI.GetAccountAggregationStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.AccountAggregationsAPI.GetAccountAggregationStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2024.AccountAggregationsAPI.GetAccountAggregationStatus(context.Background(), id).Execute()
//resp, r, err := apiClient.V2024.AccountAggregationsAPI.GetAccountAggregationStatus(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAggregationsAPI.GetAccountAggregationStatus``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)

85
docs/tools/sdk/go/Reference/V2024/Methods/AccountsAPI.md
View File

@@ -217,17 +217,6 @@ func main() {
[[Back to top]](#)
## delete-account-async
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
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.
@@ -255,7 +244,6 @@ Other parameters are passed through a pointer to a apiDeleteAccountAsyncRequest
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -282,14 +270,13 @@ import (
func main() {
id := `c350d6aa4f104c61b062cb632421ad10` // string | The account id # string | The account id
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.AccountsAPI.DeleteAccountAsync(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.AccountsAPI.DeleteAccountAsync(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2024.AccountsAPI.DeleteAccountAsync(context.Background(), id).Execute()
//resp, r, err := apiClient.V2024.AccountsAPI.DeleteAccountAsync(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DeleteAccountAsync``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -378,17 +365,6 @@ func main() {
[[Back to top]](#)
## disable-account-for-identity
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
Disable idn account for identity
This API submits a task to disable IDN account for a single identity.
@@ -410,7 +386,6 @@ Other parameters are passed through a pointer to a apiDisableAccountForIdentityR
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -437,14 +412,13 @@ import (
func main() {
id := `2c91808384203c2d018437e631158309` // string | The identity id. # string | The identity id.
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.AccountsAPI.DisableAccountForIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.AccountsAPI.DisableAccountForIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2024.AccountsAPI.DisableAccountForIdentity(context.Background(), id).Execute()
//resp, r, err := apiClient.V2024.AccountsAPI.DisableAccountForIdentity(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DisableAccountForIdentity``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -457,17 +431,6 @@ func main() {
[[Back to top]](#)
## disable-accounts-for-identities
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
Disable idn accounts for identities
This API submits tasks to disable IDN account for each identity provided in the request body.
@@ -484,7 +447,6 @@ Other parameters are passed through a pointer to a apiDisableAccountsForIdentiti
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**identitiesAccountsBulkRequest** | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | |
### Return type
@@ -511,7 +473,6 @@ import (
)
func main() {
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
identitiesaccountsbulkrequest := []byte(`{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}`) // IdentitiesAccountsBulkRequest |
@@ -525,8 +486,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.AccountsAPI.DisableAccountsForIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
//resp, r, err := apiClient.V2024.AccountsAPI.DisableAccountsForIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
resp, r, err := apiClient.V2024.AccountsAPI.DisableAccountsForIdentities(context.Background()).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
//resp, r, err := apiClient.V2024.AccountsAPI.DisableAccountsForIdentities(context.Background()).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DisableAccountsForIdentities``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -615,17 +576,6 @@ func main() {
[[Back to top]](#)
## enable-account-for-identity
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
Enable idn account for identity
This API submits a task to enable IDN account for a single identity.
@@ -647,7 +597,6 @@ Other parameters are passed through a pointer to a apiEnableAccountForIdentityRe
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -674,14 +623,13 @@ import (
func main() {
id := `2c91808384203c2d018437e631158309` // string | The identity id. # string | The identity id.
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.AccountsAPI.EnableAccountForIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.AccountsAPI.EnableAccountForIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2024.AccountsAPI.EnableAccountForIdentity(context.Background(), id).Execute()
//resp, r, err := apiClient.V2024.AccountsAPI.EnableAccountForIdentity(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.EnableAccountForIdentity``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -694,17 +642,6 @@ func main() {
[[Back to top]](#)
## enable-accounts-for-identities
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
Enable idn accounts for identities
This API submits tasks to enable IDN account for each identity provided in the request body.
@@ -721,7 +658,6 @@ Other parameters are passed through a pointer to a apiEnableAccountsForIdentitie
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**identitiesAccountsBulkRequest** | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | |
### Return type
@@ -748,7 +684,6 @@ import (
)
func main() {
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
identitiesaccountsbulkrequest := []byte(`{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}`) // IdentitiesAccountsBulkRequest |
@@ -762,8 +697,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.AccountsAPI.EnableAccountsForIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
//resp, r, err := apiClient.V2024.AccountsAPI.EnableAccountsForIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
resp, r, err := apiClient.V2024.AccountsAPI.EnableAccountsForIdentities(context.Background()).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
//resp, r, err := apiClient.V2024.AccountsAPI.EnableAccountsForIdentities(context.Background()).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.EnableAccountsForIdentities``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)

55
docs/tools/sdk/go/Reference/V2024/Methods/SourcesAPI.md
View File

@@ -76,7 +76,7 @@ Method | HTTP request | Description
[**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-accounts-async**](#delete-accounts-async) | **Post** `/sources/{id}/remove-accounts` | Remove all accounts in 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
@@ -572,18 +572,7 @@ func main() {
[[Back to top]](#)
## delete-accounts-async
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
Remove all accounts in a source
Remove all accounts in 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:
@@ -610,7 +599,6 @@ Other parameters are passed through a pointer to a apiDeleteAccountsAsyncRequest
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -637,14 +625,13 @@ import (
func main() {
id := `ebbf35756e1140699ce52b233121384a` // string | The source id # string | The source id
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.SourcesAPI.DeleteAccountsAsync(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.SourcesAPI.DeleteAccountsAsync(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2024.SourcesAPI.DeleteAccountsAsync(context.Background(), id).Execute()
//resp, r, err := apiClient.V2024.SourcesAPI.DeleteAccountsAsync(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteAccountsAsync``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -2035,17 +2022,6 @@ func main() {
[[Back to top]](#)
## import-accounts
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
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.
@@ -2069,7 +2045,6 @@ Other parameters are passed through a pointer to a apiImportAccountsRequest stru
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**file** | ***os.File** | The CSV file containing the source accounts to aggregate. |
**disableOptimization** | **string** | Use this flag to reprocess every account whether or not the data has changed. |
@@ -2098,7 +2073,6 @@ import (
func main() {
id := `ef38f94347e94562b5bb8424a56397d8` // string | Source Id # string | Source Id
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
file := BINARY_DATA_HERE // *os.File | The CSV file containing the source accounts to aggregate. (optional) # *os.File | The CSV file containing the source accounts to aggregate. (optional)
disableOptimization := `disableOptimization_example` // string | Use this flag to reprocess every account whether or not the data has changed. (optional) # string | Use this flag to reprocess every account whether or not the data has changed. (optional)
@@ -2106,8 +2080,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.SourcesAPI.ImportAccounts(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.SourcesAPI.ImportAccounts(context.Background(), id).XSailPointExperimental(xSailPointExperimental).File(file).DisableOptimization(disableOptimization).Execute()
resp, r, err := apiClient.V2024.SourcesAPI.ImportAccounts(context.Background(), id).Execute()
//resp, r, err := apiClient.V2024.SourcesAPI.ImportAccounts(context.Background(), id).File(file).DisableOptimization(disableOptimization).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportAccounts``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -2422,17 +2396,6 @@ func main() {
[[Back to top]](#)
## import-uncorrelated-accounts
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
Process uncorrelated accounts
File is required for upload. You will also need to set the Content-Type header to `multipart/form-data`
@@ -2454,7 +2417,6 @@ Other parameters are passed through a pointer to a apiImportUncorrelatedAccounts
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**file** | ***os.File** | |
### Return type
@@ -2482,15 +2444,14 @@ import (
func main() {
id := `75dbec1ebe154d5785da27b95e1dd5d7` // string | Source Id # string | Source Id
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional)
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.SourcesAPI.ImportUncorrelatedAccounts(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.SourcesAPI.ImportUncorrelatedAccounts(context.Background(), id).XSailPointExperimental(xSailPointExperimental).File(file).Execute()
resp, r, err := apiClient.V2024.SourcesAPI.ImportUncorrelatedAccounts(context.Background(), id).Execute()
//resp, r, err := apiClient.V2024.SourcesAPI.ImportUncorrelatedAccounts(context.Background(), id).File(file).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportUncorrelatedAccounts``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)

104
docs/tools/sdk/go/Reference/V2024/Models/AccountAggregationStatus.md
View File

@@ -19,6 +19,10 @@ Name | Type | Description | Notes
**Status** | Pointer to **string** | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
**TotalAccounts** | Pointer to **int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
**ProcessedAccounts** | Pointer to **int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
**TotalAccountsMarkedForDeletion** | Pointer to **int32** | The total number of accounts that have been marked for deletion during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
**DeletedAccounts** | Pointer to **int32** | The number of accounts that have been deleted during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
**TotalIdentities** | Pointer to **int32** | The total number of unique identities that have been marked for refresh. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
**ProcessedIdentities** | Pointer to **int32** | The number of unique identities that have been refreshed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
## Methods
@@ -149,4 +153,104 @@ SetProcessedAccounts sets ProcessedAccounts field to given value.
HasProcessedAccounts returns a boolean if a field has been set.
### GetTotalAccountsMarkedForDeletion
`func (o *AccountAggregationStatus) GetTotalAccountsMarkedForDeletion() int32`
GetTotalAccountsMarkedForDeletion returns the TotalAccountsMarkedForDeletion field if non-nil, zero value otherwise.
### GetTotalAccountsMarkedForDeletionOk
`func (o *AccountAggregationStatus) GetTotalAccountsMarkedForDeletionOk() (*int32, bool)`
GetTotalAccountsMarkedForDeletionOk returns a tuple with the TotalAccountsMarkedForDeletion field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTotalAccountsMarkedForDeletion
`func (o *AccountAggregationStatus) SetTotalAccountsMarkedForDeletion(v int32)`
SetTotalAccountsMarkedForDeletion sets TotalAccountsMarkedForDeletion field to given value.
### HasTotalAccountsMarkedForDeletion
`func (o *AccountAggregationStatus) HasTotalAccountsMarkedForDeletion() bool`
HasTotalAccountsMarkedForDeletion returns a boolean if a field has been set.
### GetDeletedAccounts
`func (o *AccountAggregationStatus) GetDeletedAccounts() int32`
GetDeletedAccounts returns the DeletedAccounts field if non-nil, zero value otherwise.
### GetDeletedAccountsOk
`func (o *AccountAggregationStatus) GetDeletedAccountsOk() (*int32, bool)`
GetDeletedAccountsOk returns a tuple with the DeletedAccounts field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetDeletedAccounts
`func (o *AccountAggregationStatus) SetDeletedAccounts(v int32)`
SetDeletedAccounts sets DeletedAccounts field to given value.
### HasDeletedAccounts
`func (o *AccountAggregationStatus) HasDeletedAccounts() bool`
HasDeletedAccounts returns a boolean if a field has been set.
### GetTotalIdentities
`func (o *AccountAggregationStatus) GetTotalIdentities() int32`
GetTotalIdentities returns the TotalIdentities field if non-nil, zero value otherwise.
### GetTotalIdentitiesOk
`func (o *AccountAggregationStatus) GetTotalIdentitiesOk() (*int32, bool)`
GetTotalIdentitiesOk returns a tuple with the TotalIdentities field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTotalIdentities
`func (o *AccountAggregationStatus) SetTotalIdentities(v int32)`
SetTotalIdentities sets TotalIdentities field to given value.
### HasTotalIdentities
`func (o *AccountAggregationStatus) HasTotalIdentities() bool`
HasTotalIdentities returns a boolean if a field has been set.
### GetProcessedIdentities
`func (o *AccountAggregationStatus) GetProcessedIdentities() int32`
GetProcessedIdentities returns the ProcessedIdentities field if non-nil, zero value otherwise.
### GetProcessedIdentitiesOk
`func (o *AccountAggregationStatus) GetProcessedIdentitiesOk() (*int32, bool)`
GetProcessedIdentitiesOk returns a tuple with the ProcessedIdentities field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetProcessedIdentities
`func (o *AccountAggregationStatus) SetProcessedIdentities(v int32)`
SetProcessedIdentities sets ProcessedIdentities field to given value.
### HasProcessedIdentities
`func (o *AccountAggregationStatus) HasProcessedIdentities() bool`
HasProcessedIdentities returns a boolean if a field has been set.

17
docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestsAPI.md
View File

@@ -256,17 +256,6 @@ func main() {
[[Back to top]](#)
## close-access-request
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
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/).
@@ -294,7 +283,6 @@ Other parameters are passed through a pointer to a apiCloseAccessRequestRequest
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**closeAccessRequest** | [**CloseAccessRequest**](../models/close-access-request) | |
### Return type
@@ -321,7 +309,6 @@ import (
)
func main() {
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
closeaccessrequest := []byte(`{
"executionStatus" : "Terminated",
"accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
@@ -338,8 +325,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2025.AccessRequestsAPI.CloseAccessRequest(context.Background()).XSailPointExperimental(xSailPointExperimental).CloseAccessRequest(closeAccessRequest).Execute()
//resp, r, err := apiClient.V2025.AccessRequestsAPI.CloseAccessRequest(context.Background()).XSailPointExperimental(xSailPointExperimental).CloseAccessRequest(closeAccessRequest).Execute()
resp, r, err := apiClient.V2025.AccessRequestsAPI.CloseAccessRequest(context.Background()).CloseAccessRequest(closeAccessRequest).Execute()
//resp, r, err := apiClient.V2025.AccessRequestsAPI.CloseAccessRequest(context.Background()).CloseAccessRequest(closeAccessRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CloseAccessRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)

17
docs/tools/sdk/go/Reference/V2025/Methods/AccountAggregationsAPI.md
View File

@@ -29,17 +29,6 @@ Method | HTTP request | Description
## get-account-aggregation-status
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
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.
@@ -68,7 +57,6 @@ Other parameters are passed through a pointer to a apiGetAccountAggregationStatu
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -95,14 +83,13 @@ import (
func main() {
id := `2c91808477a6b0c60177a81146b8110b` // string | The account aggregation id # string | The account aggregation id
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2025.AccountAggregationsAPI.GetAccountAggregationStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2025.AccountAggregationsAPI.GetAccountAggregationStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2025.AccountAggregationsAPI.GetAccountAggregationStatus(context.Background(), id).Execute()
//resp, r, err := apiClient.V2025.AccountAggregationsAPI.GetAccountAggregationStatus(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountAggregationsAPI.GetAccountAggregationStatus``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)

85
docs/tools/sdk/go/Reference/V2025/Methods/AccountsAPI.md
View File

@@ -217,17 +217,6 @@ func main() {
[[Back to top]](#)
## delete-account-async
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
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.
@@ -255,7 +244,6 @@ Other parameters are passed through a pointer to a apiDeleteAccountAsyncRequest
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -282,14 +270,13 @@ import (
func main() {
id := `c350d6aa4f104c61b062cb632421ad10` // string | The account id # string | The account id
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2025.AccountsAPI.DeleteAccountAsync(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2025.AccountsAPI.DeleteAccountAsync(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2025.AccountsAPI.DeleteAccountAsync(context.Background(), id).Execute()
//resp, r, err := apiClient.V2025.AccountsAPI.DeleteAccountAsync(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DeleteAccountAsync``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -378,17 +365,6 @@ func main() {
[[Back to top]](#)
## disable-account-for-identity
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
Disable idn account for identity
This API submits a task to disable IDN account for a single identity.
@@ -410,7 +386,6 @@ Other parameters are passed through a pointer to a apiDisableAccountForIdentityR
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -437,14 +412,13 @@ import (
func main() {
id := `2c91808384203c2d018437e631158309` // string | The identity id. # string | The identity id.
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2025.AccountsAPI.DisableAccountForIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2025.AccountsAPI.DisableAccountForIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2025.AccountsAPI.DisableAccountForIdentity(context.Background(), id).Execute()
//resp, r, err := apiClient.V2025.AccountsAPI.DisableAccountForIdentity(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DisableAccountForIdentity``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -457,17 +431,6 @@ func main() {
[[Back to top]](#)
## disable-accounts-for-identities
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
Disable idn accounts for identities
This API submits tasks to disable IDN account for each identity provided in the request body.
@@ -484,7 +447,6 @@ Other parameters are passed through a pointer to a apiDisableAccountsForIdentiti
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**identitiesAccountsBulkRequest** | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | |
### Return type
@@ -511,7 +473,6 @@ import (
)
func main() {
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
identitiesaccountsbulkrequest := []byte(`{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}`) // IdentitiesAccountsBulkRequest |
@@ -525,8 +486,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2025.AccountsAPI.DisableAccountsForIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
//resp, r, err := apiClient.V2025.AccountsAPI.DisableAccountsForIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
resp, r, err := apiClient.V2025.AccountsAPI.DisableAccountsForIdentities(context.Background()).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
//resp, r, err := apiClient.V2025.AccountsAPI.DisableAccountsForIdentities(context.Background()).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DisableAccountsForIdentities``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -615,17 +576,6 @@ func main() {
[[Back to top]](#)
## enable-account-for-identity
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
Enable idn account for identity
This API submits a task to enable IDN account for a single identity.
@@ -647,7 +597,6 @@ Other parameters are passed through a pointer to a apiEnableAccountForIdentityRe
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -674,14 +623,13 @@ import (
func main() {
id := `2c91808384203c2d018437e631158309` // string | The identity id. # string | The identity id.
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2025.AccountsAPI.EnableAccountForIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2025.AccountsAPI.EnableAccountForIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2025.AccountsAPI.EnableAccountForIdentity(context.Background(), id).Execute()
//resp, r, err := apiClient.V2025.AccountsAPI.EnableAccountForIdentity(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.EnableAccountForIdentity``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -694,17 +642,6 @@ func main() {
[[Back to top]](#)
## enable-accounts-for-identities
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
Enable idn accounts for identities
This API submits tasks to enable IDN account for each identity provided in the request body.
@@ -721,7 +658,6 @@ Other parameters are passed through a pointer to a apiEnableAccountsForIdentitie
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**identitiesAccountsBulkRequest** | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | |
### Return type
@@ -748,7 +684,6 @@ import (
)
func main() {
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
identitiesaccountsbulkrequest := []byte(`{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}`) // IdentitiesAccountsBulkRequest |
@@ -762,8 +697,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2025.AccountsAPI.EnableAccountsForIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
//resp, r, err := apiClient.V2025.AccountsAPI.EnableAccountsForIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
resp, r, err := apiClient.V2025.AccountsAPI.EnableAccountsForIdentities(context.Background()).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
//resp, r, err := apiClient.V2025.AccountsAPI.EnableAccountsForIdentities(context.Background()).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.EnableAccountsForIdentities``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)

38
docs/tools/sdk/go/Reference/V2025/Methods/SourcesAPI.md
View File

@@ -76,7 +76,7 @@ Method | HTTP request | Description
[**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-accounts-async**](#delete-accounts-async) | **Post** `/sources/{id}/remove-accounts` | Remove all accounts in 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
@@ -572,18 +572,7 @@ func main() {
[[Back to top]](#)
## delete-accounts-async
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
Remove all accounts in a source
Remove all accounts in 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:
@@ -610,7 +599,6 @@ Other parameters are passed through a pointer to a apiDeleteAccountsAsyncRequest
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -637,14 +625,13 @@ import (
func main() {
id := `ebbf35756e1140699ce52b233121384a` // string | The source id # string | The source id
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2025.SourcesAPI.DeleteAccountsAsync(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2025.SourcesAPI.DeleteAccountsAsync(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2025.SourcesAPI.DeleteAccountsAsync(context.Background(), id).Execute()
//resp, r, err := apiClient.V2025.SourcesAPI.DeleteAccountsAsync(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteAccountsAsync``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -2409,17 +2396,6 @@ func main() {
[[Back to top]](#)
## import-uncorrelated-accounts
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```go
configuration = Configuration()
configuration.experimental = True
```
:::
Process uncorrelated accounts
File is required for upload. You will also need to set the Content-Type header to `multipart/form-data`
@@ -2441,7 +2417,6 @@ Other parameters are passed through a pointer to a apiImportUncorrelatedAccounts
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**file** | ***os.File** | |
### Return type
@@ -2469,15 +2444,14 @@ import (
func main() {
id := `75dbec1ebe154d5785da27b95e1dd5d7` // string | Source Id # string | Source Id
xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional)
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2025.SourcesAPI.ImportUncorrelatedAccounts(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2025.SourcesAPI.ImportUncorrelatedAccounts(context.Background(), id).XSailPointExperimental(xSailPointExperimental).File(file).Execute()
resp, r, err := apiClient.V2025.SourcesAPI.ImportUncorrelatedAccounts(context.Background(), id).Execute()
//resp, r, err := apiClient.V2025.SourcesAPI.ImportUncorrelatedAccounts(context.Background(), id).File(file).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportUncorrelatedAccounts``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)

104
docs/tools/sdk/go/Reference/V2025/Models/AccountAggregationStatus.md
View File

@@ -19,6 +19,10 @@ Name | Type | Description | Notes
**Status** | Pointer to **string** | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
**TotalAccounts** | Pointer to **int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
**ProcessedAccounts** | Pointer to **int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
**TotalAccountsMarkedForDeletion** | Pointer to **int32** | The total number of accounts that have been marked for deletion during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
**DeletedAccounts** | Pointer to **int32** | The number of accounts that have been deleted during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
**TotalIdentities** | Pointer to **int32** | The total number of unique identities that have been marked for refresh. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
**ProcessedIdentities** | Pointer to **int32** | The number of unique identities that have been refreshed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
## Methods
@@ -149,4 +153,104 @@ SetProcessedAccounts sets ProcessedAccounts field to given value.
HasProcessedAccounts returns a boolean if a field has been set.
### GetTotalAccountsMarkedForDeletion
`func (o *AccountAggregationStatus) GetTotalAccountsMarkedForDeletion() int32`
GetTotalAccountsMarkedForDeletion returns the TotalAccountsMarkedForDeletion field if non-nil, zero value otherwise.
### GetTotalAccountsMarkedForDeletionOk
`func (o *AccountAggregationStatus) GetTotalAccountsMarkedForDeletionOk() (*int32, bool)`
GetTotalAccountsMarkedForDeletionOk returns a tuple with the TotalAccountsMarkedForDeletion field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTotalAccountsMarkedForDeletion
`func (o *AccountAggregationStatus) SetTotalAccountsMarkedForDeletion(v int32)`
SetTotalAccountsMarkedForDeletion sets TotalAccountsMarkedForDeletion field to given value.
### HasTotalAccountsMarkedForDeletion
`func (o *AccountAggregationStatus) HasTotalAccountsMarkedForDeletion() bool`
HasTotalAccountsMarkedForDeletion returns a boolean if a field has been set.
### GetDeletedAccounts
`func (o *AccountAggregationStatus) GetDeletedAccounts() int32`
GetDeletedAccounts returns the DeletedAccounts field if non-nil, zero value otherwise.
### GetDeletedAccountsOk
`func (o *AccountAggregationStatus) GetDeletedAccountsOk() (*int32, bool)`
GetDeletedAccountsOk returns a tuple with the DeletedAccounts field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetDeletedAccounts
`func (o *AccountAggregationStatus) SetDeletedAccounts(v int32)`
SetDeletedAccounts sets DeletedAccounts field to given value.
### HasDeletedAccounts
`func (o *AccountAggregationStatus) HasDeletedAccounts() bool`
HasDeletedAccounts returns a boolean if a field has been set.
### GetTotalIdentities
`func (o *AccountAggregationStatus) GetTotalIdentities() int32`
GetTotalIdentities returns the TotalIdentities field if non-nil, zero value otherwise.
### GetTotalIdentitiesOk
`func (o *AccountAggregationStatus) GetTotalIdentitiesOk() (*int32, bool)`
GetTotalIdentitiesOk returns a tuple with the TotalIdentities field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTotalIdentities
`func (o *AccountAggregationStatus) SetTotalIdentities(v int32)`
SetTotalIdentities sets TotalIdentities field to given value.
### HasTotalIdentities
`func (o *AccountAggregationStatus) HasTotalIdentities() bool`
HasTotalIdentities returns a boolean if a field has been set.
### GetProcessedIdentities
`func (o *AccountAggregationStatus) GetProcessedIdentities() int32`
GetProcessedIdentities returns the ProcessedIdentities field if non-nil, zero value otherwise.
### GetProcessedIdentitiesOk
`func (o *AccountAggregationStatus) GetProcessedIdentitiesOk() (*int32, bool)`
GetProcessedIdentitiesOk returns a tuple with the ProcessedIdentities field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetProcessedIdentities
`func (o *AccountAggregationStatus) SetProcessedIdentities(v int32)`
SetProcessedIdentities sets ProcessedIdentities field to given value.
### HasProcessedIdentities
`func (o *AccountAggregationStatus) HasProcessedIdentities() bool`
HasProcessedIdentities returns a boolean if a field has been set.