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

Update Go SDK docs: 15683610903

Browse Source
This commit is contained in:
developer-relations-sp
2025-06-16 14:28:43 +00:00
parent b6e2c44152
commit 3af0fca7b1
53 changed files with 3272 additions and 650 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -361,8 +361,9 @@ if you submit duplicate access requests in quick succession or submit an access
It's best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can
be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also
use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting
an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request.
These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API.
an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has,
without changing the account details or end date information from the existing assignment,
the API will cancel the request as a duplicate.
There are two types of access request:
@@ -371,17 +372,19 @@ __GRANT_ACCESS__
* Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options.
* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others.
* Roles, access profiles and entitlements can be requested.
* You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time.
* If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time.
* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request.
* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source.
__REVOKE_ACCESS__
* Can only be requested for a single identity at a time.
* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning.
* Does not support self request. Only manager can request to revoke access for their directly managed employees.
* If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements.
* If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time.
* Roles, access profiles, and entitlements can be requested for revocation.
* Revoke requests for entitlements are limited to 1 entitlement per access request currently.
* You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone.
* You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time.
* Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone.
* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. These fields should be used within the 'requestedItems' section for the revoke requests.
* Usage of 'requestedForWithRequestedItems' field is not supported for revoke requests.

136
docs/tools/sdk/go/Reference/V2024/Methods/IdentitiesAPI.md
View File

@@ -44,17 +44,6 @@ Method | HTTP request | Description
## delete-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
```
:::
Delete identity
The API returns successful response if the requested identity was deleted.
@@ -76,7 +65,6 @@ Other parameters are passed through a pointer to a apiDeleteIdentityRequest stru
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -103,14 +91,13 @@ import (
func main() {
id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id # string | 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)
r, err := apiClient.V2024.IdentitiesAPI.DeleteIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//r, err := apiClient.V2024.IdentitiesAPI.DeleteIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
r, err := apiClient.V2024.IdentitiesAPI.DeleteIdentity(context.Background(), id).Execute()
//r, err := apiClient.V2024.IdentitiesAPI.DeleteIdentity(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.DeleteIdentity``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -122,17 +109,6 @@ func main() {
[[Back to top]](#)
## get-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
```
:::
Identity details
This API returns a single identity using the Identity ID.
@@ -154,7 +130,6 @@ Other parameters are passed through a pointer to a apiGetIdentityRequest struct
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -181,14 +156,13 @@ import (
func main() {
id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id # string | 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.IdentitiesAPI.GetIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.IdentitiesAPI.GetIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2024.IdentitiesAPI.GetIdentity(context.Background(), id).Execute()
//resp, r, err := apiClient.V2024.IdentitiesAPI.GetIdentity(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.GetIdentity``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -201,17 +175,6 @@ func main() {
[[Back to top]](#)
## get-identity-ownership-details
:::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
```
:::
Get ownership details
Use this API to return an identity's owned objects that will cause problems for deleting the identity.
Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity.
@@ -235,7 +198,6 @@ Other parameters are passed through a pointer to a apiGetIdentityOwnershipDetail
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -262,14 +224,13 @@ import (
func main() {
identityId := `ff8081814d2a8036014d701f3fbf53fa` // string | Identity ID. # string | 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.IdentitiesAPI.GetIdentityOwnershipDetails(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.IdentitiesAPI.GetIdentityOwnershipDetails(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2024.IdentitiesAPI.GetIdentityOwnershipDetails(context.Background(), identityId).Execute()
//resp, r, err := apiClient.V2024.IdentitiesAPI.GetIdentityOwnershipDetails(context.Background(), identityId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.GetIdentityOwnershipDetails``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -282,17 +243,6 @@ func main() {
[[Back to top]](#)
## get-role-assignment
:::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
```
:::
Role assignment details
@@ -316,7 +266,6 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -344,14 +293,13 @@ import (
func main() {
identityId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id # string | Identity Id
assignmentId := `1cbb0705b38c4226b1334eadd8874086` // string | Assignment Id # string | Assignment 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.IdentitiesAPI.GetRoleAssignment(context.Background(), identityId, assignmentId).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.IdentitiesAPI.GetRoleAssignment(context.Background(), identityId, assignmentId).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2024.IdentitiesAPI.GetRoleAssignment(context.Background(), identityId, assignmentId).Execute()
//resp, r, err := apiClient.V2024.IdentitiesAPI.GetRoleAssignment(context.Background(), identityId, assignmentId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.GetRoleAssignment``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -364,17 +312,6 @@ func main() {
[[Back to top]](#)
## get-role-assignments
:::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
```
:::
List role assignments
This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id.
@@ -396,7 +333,6 @@ Other parameters are passed through a pointer to a apiGetRoleAssignmentsRequest
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**roleId** | **string** | Role Id to filter the role assignments with |
**roleName** | **string** | Role name to filter the role assignments with |
@@ -425,7 +361,6 @@ import (
func main() {
identityId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id to get the role assignments for # string | Identity Id to get the role assignments for
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")
roleId := `e7697a1e96d04db1ac7b0f4544915d2c` // string | Role Id to filter the role assignments with (optional) # string | Role Id to filter the role assignments with (optional)
roleName := `Engineer` // string | Role name to filter the role assignments with (optional) # string | Role name to filter the role assignments with (optional)
@@ -433,8 +368,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.IdentitiesAPI.GetRoleAssignments(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.IdentitiesAPI.GetRoleAssignments(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).RoleId(roleId).RoleName(roleName).Execute()
resp, r, err := apiClient.V2024.IdentitiesAPI.GetRoleAssignments(context.Background(), identityId).Execute()
//resp, r, err := apiClient.V2024.IdentitiesAPI.GetRoleAssignments(context.Background(), identityId).RoleId(roleId).RoleName(roleName).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.GetRoleAssignments``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -447,17 +382,6 @@ func main() {
[[Back to top]](#)
## list-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
```
:::
List identities
This API returns a list of identities.
@@ -474,7 +398,6 @@ Other parameters are passed through a pointer to a apiListIdentitiesRequest stru
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* |
**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** |
**defaultFilter** | **string** | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. | [default to "CORRELATED_ONLY"]
@@ -506,7 +429,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")
filters := `id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false` // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) # string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional)
sorters := `name,-cloudStatus` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) # string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional)
defaultFilter := `NONE` // string | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") # string | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY")
@@ -518,8 +440,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.IdentitiesAPI.ListIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.IdentitiesAPI.ListIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Sorters(sorters).DefaultFilter(defaultFilter).Count(count).Limit(limit).Offset(offset).Execute()
resp, r, err := apiClient.V2024.IdentitiesAPI.ListIdentities(context.Background()).Execute()
//resp, r, err := apiClient.V2024.IdentitiesAPI.ListIdentities(context.Background()).Filters(filters).Sorters(sorters).DefaultFilter(defaultFilter).Count(count).Limit(limit).Offset(offset).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.ListIdentities``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -532,17 +454,6 @@ func main() {
[[Back to top]](#)
## reset-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
```
:::
Reset an identity
Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.
@@ -564,7 +475,6 @@ Other parameters are passed through a pointer to a apiResetIdentityRequest struc
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -591,14 +501,13 @@ import (
func main() {
identityId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id # string | 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)
r, err := apiClient.V2024.IdentitiesAPI.ResetIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute()
//r, err := apiClient.V2024.IdentitiesAPI.ResetIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute()
r, err := apiClient.V2024.IdentitiesAPI.ResetIdentity(context.Background(), identityId).Execute()
//r, err := apiClient.V2024.IdentitiesAPI.ResetIdentity(context.Background(), identityId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.ResetIdentity``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -699,17 +608,6 @@ func main() {
[[Back to top]](#)
## start-identities-invite
:::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
```
:::
Invite identities to register
This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options.
@@ -731,7 +629,6 @@ Other parameters are passed through a pointer to a apiStartIdentitiesInviteReque
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**inviteIdentitiesRequest** | [**InviteIdentitiesRequest**](../models/invite-identities-request) | |
### Return type
@@ -758,7 +655,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")
inviteidentitiesrequest := []byte(`{
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
"uninvited" : false
@@ -773,8 +669,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.IdentitiesAPI.StartIdentitiesInvite(context.Background()).XSailPointExperimental(xSailPointExperimental).InviteIdentitiesRequest(inviteIdentitiesRequest).Execute()
//resp, r, err := apiClient.V2024.IdentitiesAPI.StartIdentitiesInvite(context.Background()).XSailPointExperimental(xSailPointExperimental).InviteIdentitiesRequest(inviteIdentitiesRequest).Execute()
resp, r, err := apiClient.V2024.IdentitiesAPI.StartIdentitiesInvite(context.Background()).InviteIdentitiesRequest(inviteIdentitiesRequest).Execute()
//resp, r, err := apiClient.V2024.IdentitiesAPI.StartIdentitiesInvite(context.Background()).InviteIdentitiesRequest(inviteIdentitiesRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.StartIdentitiesInvite``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)

102
docs/tools/sdk/go/Reference/V2024/Methods/IdentityAttributesAPI.md
View File

@@ -24,17 +24,6 @@ Method | HTTP request | Description
## create-identity-attribute
:::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
```
:::
Create identity attribute
Use this API to create a new identity attribute.
@@ -51,7 +40,6 @@ Other parameters are passed through a pointer to a apiCreateIdentityAttributeReq
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**identityAttribute** | [**IdentityAttribute**](../models/identity-attribute) | |
### Return type
@@ -78,7 +66,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")
identityattribute := []byte(`{
"standard" : false,
"system" : false,
@@ -111,8 +98,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.IdentityAttributesAPI.CreateIdentityAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityAttribute(identityAttribute).Execute()
//resp, r, err := apiClient.V2024.IdentityAttributesAPI.CreateIdentityAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityAttribute(identityAttribute).Execute()
resp, r, err := apiClient.V2024.IdentityAttributesAPI.CreateIdentityAttribute(context.Background()).IdentityAttribute(identityAttribute).Execute()
//resp, r, err := apiClient.V2024.IdentityAttributesAPI.CreateIdentityAttribute(context.Background()).IdentityAttribute(identityAttribute).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentityAttributesAPI.CreateIdentityAttribute``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -125,17 +112,6 @@ func main() {
[[Back to top]](#)
## delete-identity-attribute
:::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
```
:::
Delete identity attribute
This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute.
@@ -157,7 +133,6 @@ Other parameters are passed through a pointer to a apiDeleteIdentityAttributeReq
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -184,14 +159,13 @@ import (
func main() {
name := `displayName` // string | The attribute's technical name. # string | The attribute's technical name.
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)
r, err := apiClient.V2024.IdentityAttributesAPI.DeleteIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute()
//r, err := apiClient.V2024.IdentityAttributesAPI.DeleteIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute()
r, err := apiClient.V2024.IdentityAttributesAPI.DeleteIdentityAttribute(context.Background(), name).Execute()
//r, err := apiClient.V2024.IdentityAttributesAPI.DeleteIdentityAttribute(context.Background(), name).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentityAttributesAPI.DeleteIdentityAttribute``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -203,17 +177,6 @@ func main() {
[[Back to top]](#)
## delete-identity-attributes-in-bulk
:::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
```
:::
Bulk delete identity attributes
Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute.
@@ -230,7 +193,6 @@ Other parameters are passed through a pointer to a apiDeleteIdentityAttributesIn
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**identityAttributeNames** | [**IdentityAttributeNames**](../models/identity-attribute-names) | |
### Return type
@@ -257,7 +219,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")
identityattributenames := []byte(`{
"ids" : [ "name", "displayName" ]
}`) // IdentityAttributeNames |
@@ -271,8 +232,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
r, err := apiClient.V2024.IdentityAttributesAPI.DeleteIdentityAttributesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityAttributeNames(identityAttributeNames).Execute()
//r, err := apiClient.V2024.IdentityAttributesAPI.DeleteIdentityAttributesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityAttributeNames(identityAttributeNames).Execute()
r, err := apiClient.V2024.IdentityAttributesAPI.DeleteIdentityAttributesInBulk(context.Background()).IdentityAttributeNames(identityAttributeNames).Execute()
//r, err := apiClient.V2024.IdentityAttributesAPI.DeleteIdentityAttributesInBulk(context.Background()).IdentityAttributeNames(identityAttributeNames).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentityAttributesAPI.DeleteIdentityAttributesInBulk``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -284,17 +245,6 @@ func main() {
[[Back to top]](#)
## get-identity-attribute
:::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
```
:::
Get identity attribute
This gets an identity attribute for a given technical name.
@@ -316,7 +266,6 @@ Other parameters are passed through a pointer to a apiGetIdentityAttributeReques
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -343,14 +292,13 @@ import (
func main() {
name := `displayName` // string | The attribute's technical name. # string | The attribute's technical name.
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.IdentityAttributesAPI.GetIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.IdentityAttributesAPI.GetIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2024.IdentityAttributesAPI.GetIdentityAttribute(context.Background(), name).Execute()
//resp, r, err := apiClient.V2024.IdentityAttributesAPI.GetIdentityAttribute(context.Background(), name).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentityAttributesAPI.GetIdentityAttribute``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -363,17 +311,6 @@ func main() {
[[Back to top]](#)
## list-identity-attributes
:::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
```
:::
List identity attributes
Use this API to get a collection of identity attributes.
@@ -390,7 +327,6 @@ Other parameters are passed through a pointer to a apiListIdentityAttributesRequ
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**includeSystem** | **bool** | Include 'system' attributes in the response. | [default to false]
**includeSilent** | **bool** | Include 'silent' attributes in the response. | [default to false]
**searchableOnly** | **bool** | Include only 'searchable' attributes in the response. | [default to false]
@@ -420,7 +356,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")
includeSystem := false // bool | Include 'system' attributes in the response. (optional) (default to false) # bool | Include 'system' attributes in the response. (optional) (default to false)
includeSilent := false // bool | Include 'silent' attributes in the response. (optional) (default to false) # bool | Include 'silent' attributes in the response. (optional) (default to false)
searchableOnly := false // bool | Include only 'searchable' attributes in the response. (optional) (default to false) # bool | Include only 'searchable' attributes in the response. (optional) (default to false)
@@ -430,8 +365,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.IdentityAttributesAPI.ListIdentityAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.IdentityAttributesAPI.ListIdentityAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).IncludeSystem(includeSystem).IncludeSilent(includeSilent).SearchableOnly(searchableOnly).Count(count).Execute()
resp, r, err := apiClient.V2024.IdentityAttributesAPI.ListIdentityAttributes(context.Background()).Execute()
//resp, r, err := apiClient.V2024.IdentityAttributesAPI.ListIdentityAttributes(context.Background()).IncludeSystem(includeSystem).IncludeSilent(includeSilent).SearchableOnly(searchableOnly).Count(count).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentityAttributesAPI.ListIdentityAttributes``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -444,17 +379,6 @@ func main() {
[[Back to top]](#)
## put-identity-attribute
:::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
```
:::
Update identity attribute
This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false.
@@ -476,7 +400,6 @@ Other parameters are passed through a pointer to a apiPutIdentityAttributeReques
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**identityAttribute** | [**IdentityAttribute**](../models/identity-attribute) | |
### Return type
@@ -504,7 +427,6 @@ import (
func main() {
name := `displayName` // string | The attribute's technical name. # string | The attribute's technical name.
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")
identityattribute := []byte(`{
"standard" : false,
"system" : false,
@@ -537,8 +459,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.IdentityAttributesAPI.PutIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).IdentityAttribute(identityAttribute).Execute()
//resp, r, err := apiClient.V2024.IdentityAttributesAPI.PutIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).IdentityAttribute(identityAttribute).Execute()
resp, r, err := apiClient.V2024.IdentityAttributesAPI.PutIdentityAttribute(context.Background(), name).IdentityAttribute(identityAttribute).Execute()
//resp, r, err := apiClient.V2024.IdentityAttributesAPI.PutIdentityAttribute(context.Background(), name).IdentityAttribute(identityAttribute).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IdentityAttributesAPI.PutIdentityAttribute``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)

4
docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountMappingsAPI.md
View File

@@ -18,7 +18,7 @@ Method | HTTP request | Description
[**create-machine-account-mappings**](#create-machine-account-mappings) | **Post** `/sources/{sourceId}/machine-account-mappings` | Create machine account mappings
[**delete-machine-account-mappings**](#delete-machine-account-mappings) | **Delete** `/sources/{sourceId}/machine-account-mappings` | Delete source's machine account mappings
[**list-machine-account-mappings**](#list-machine-account-mappings) | **Get** `/sources/{sourceId}/machine-account-mappings` | Machine account mapping for source
[**set-machine-account-mappings**](#set-machine-account-mappings) | **Put** `/sources/{sourceId}/machine-mappings` | Update source's machine account mappings
[**set-machine-account-mappings**](#set-machine-account-mappings) | **Put** `/sources/{sourceId}/machine-mappings` | Update Source's Machine Account Mappings
## create-machine-account-mappings
@@ -252,7 +252,7 @@ func main() {
[[Back to top]](#)
## set-machine-account-mappings
Update source's machine account mappings
Update Source's Machine Account Mappings
Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-machine-account-mappings)

4
docs/tools/sdk/go/Reference/V2024/Methods/RequestableObjectsAPI.md
View File

@@ -40,7 +40,7 @@ Other parameters are passed through a pointer to a apiListRequestableObjectsRequ
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identityId** | **string** | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. |
**types** | [**[]RequestableObjectType**](../models/requestable-object-type) | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. |
**types** | **[]string** | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. |
**term** | **string** | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. |
**statuses** | [**[]RequestableObjectRequestStatus**](../models/requestable-object-request-status) | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. |
**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]
@@ -74,7 +74,7 @@ import (
func main() {
identityId := `e7eab60924f64aa284175b9fa3309599` // string | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) # string | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional)
types := []byte(`ROLE,ACCESS_PROFILE`) // []RequestableObjectType | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional)
types := []byte(`ACCESS_PROFILE,ROLE`) // []string | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional)
term := `Finance Role` // string | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) # string | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional)
statuses := []byte(`[ASSIGNED, PENDING]`) // []RequestableObjectRequestStatus | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional)
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)

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

@@ -100,6 +100,7 @@ Method | HTTP request | Description
[**import-accounts**](#import-accounts) | **Post** `/sources/{id}/load-accounts` | Account aggregation
[**import-accounts-schema**](#import-accounts-schema) | **Post** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template
[**import-connector-file**](#import-connector-file) | **Post** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source
[**import-entitlements**](#import-entitlements) | **Post** `/sources/{sourceId}/load-entitlements` | Entitlement aggregation
[**import-entitlements-schema**](#import-entitlements-schema) | **Post** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template
[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **Post** `/sources/{id}/load-uncorrelated-accounts` | Process uncorrelated accounts
[**list-provisioning-policies**](#list-provisioning-policies) | **Get** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies
@@ -656,17 +657,6 @@ func main() {
[[Back to top]](#)
## delete-native-change-detection-config
:::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
```
:::
Delete native change detection configuration
Deletes the native change detection configuration for the source specified by the given ID.
@@ -688,7 +678,6 @@ Other parameters are passed through a pointer to a apiDeleteNativeChangeDetectio
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -715,14 +704,13 @@ import (
func main() {
id := `2c9180835d191a86015d28455b4a2329` // 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)
r, err := apiClient.V2024.SourcesAPI.DeleteNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//r, err := apiClient.V2024.SourcesAPI.DeleteNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
r, err := apiClient.V2024.SourcesAPI.DeleteNativeChangeDetectionConfig(context.Background(), id).Execute()
//r, err := apiClient.V2024.SourcesAPI.DeleteNativeChangeDetectionConfig(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteNativeChangeDetectionConfig``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -1206,17 +1194,6 @@ func main() {
[[Back to top]](#)
## get-native-change-detection-config
:::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
```
:::
Native change detection configuration
This API returns the existing native change detection configuration for a source specified by the given ID.
@@ -1238,7 +1215,6 @@ Other parameters are passed through a pointer to a apiGetNativeChangeDetectionCo
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
### Return type
@@ -1265,14 +1241,13 @@ import (
func main() {
id := `2c9180835d191a86015d28455b4a2329` // 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.GetNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.SourcesAPI.GetNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute()
resp, r, err := apiClient.V2024.SourcesAPI.GetNativeChangeDetectionConfig(context.Background(), id).Execute()
//resp, r, err := apiClient.V2024.SourcesAPI.GetNativeChangeDetectionConfig(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetNativeChangeDetectionConfig``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -2286,6 +2261,90 @@ func main() {
[[Back to top]](#)
## import-entitlements
:::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
```
:::
Entitlement aggregation
Starts an entitlement aggregation on the specified source.
If the target source is a delimited file source, then the CSV file needs to be included in the request body.
You will also need to set the Content-Type header to `multipart/form-data`.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-entitlements)
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**sourceId** | **string** | Source Id |
### Other Parameters
Other parameters are passed through a pointer to a apiImportEntitlementsRequest struct via the builder pattern
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 entitlements to aggregate. |
### Return type
[**LoadEntitlementTask**](../models/load-entitlement-task)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
### Example
```go
package main
import (
"context"
"fmt"
"os"
sailpoint "github.com/sailpoint-oss/golang-sdk/v2"
)
func main() {
sourceId := `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 entitlements to aggregate. (optional) # *os.File | The CSV file containing the source entitlements to aggregate. (optional)
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.SourcesAPI.ImportEntitlements(context.Background(), sourceId).XSailPointExperimental(xSailPointExperimental).Execute()
//resp, r, err := apiClient.V2024.SourcesAPI.ImportEntitlements(context.Background(), sourceId).XSailPointExperimental(xSailPointExperimental).File(file).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportEntitlements``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ImportEntitlements`: LoadEntitlementTask
fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportEntitlements`: %v\n", resp)
}
```
[[Back to top]](#)
## import-entitlements-schema
Uploads source entitlements schema template
This API uploads a source schema template file to configure a source's entitlement attributes.
@@ -2743,17 +2802,6 @@ func main() {
[[Back to top]](#)
## put-native-change-detection-config
:::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
```
:::
Update native change detection configuration
Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body.
@@ -2775,7 +2823,6 @@ Other parameters are passed through a pointer to a apiPutNativeChangeDetectionCo
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"]
**nativeChangeDetectionConfig** | [**NativeChangeDetectionConfig**](../models/native-change-detection-config) | |
### Return type
@@ -2803,7 +2850,6 @@ import (
func main() {
id := `2c9180835d191a86015d28455b4a2329` // 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")
nativechangedetectionconfig := []byte(`{
"selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ],
"operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ],
@@ -2822,8 +2868,8 @@ func main() {
configuration := sailpoint.NewDefaultConfiguration()
apiClient := sailpoint.NewAPIClient(configuration)
resp, r, err := apiClient.V2024.SourcesAPI.PutNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).NativeChangeDetectionConfig(nativeChangeDetectionConfig).Execute()
//resp, r, err := apiClient.V2024.SourcesAPI.PutNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).NativeChangeDetectionConfig(nativeChangeDetectionConfig).Execute()
resp, r, err := apiClient.V2024.SourcesAPI.PutNativeChangeDetectionConfig(context.Background(), id).NativeChangeDetectionConfig(nativeChangeDetectionConfig).Execute()
//resp, r, err := apiClient.V2024.SourcesAPI.PutNativeChangeDetectionConfig(context.Background(), id).NativeChangeDetectionConfig(nativeChangeDetectionConfig).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutNativeChangeDetectionConfig``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)