Update Go SDK docs: 16148694604

This commit is contained in:
developer-relations-sp
2025-07-08 16:18:11 +00:00
parent 16e520a919
commit 9e3d1c10a6
5 changed files with 232 additions and 18 deletions

View File

@@ -111,6 +111,9 @@ import (
func main() {
identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID.
lifecyclestate := []byte(`{
"accessActionConfiguration" : {
"removeAllAccessEnabled" : true
},
"accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ],
"emailNotificationOption" : {
"notifyManagers" : true,
@@ -119,21 +122,26 @@ func main() {
"notifyAllAdmins" : true
},
"created" : "2015-05-28T14:07:17Z",
"description" : "Lifecycle description",
"identityCount" : 42,
"priority" : 10,
"technicalName" : "Technical Name",
"identityState" : "INACTIVE_LONG_TERM",
"enabled" : true,
"name" : "aName",
"modified" : "2015-05-28T14:07:17Z",
"description" : "Lifecycle description",
"accountActions" : [ {
"allSources" : true,
"action" : "ENABLE",
"excludeSourceIds" : [ "3b551ccf5566478b9b77f37de25303aa" ],
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
}, {
"allSources" : true,
"action" : "ENABLE",
"excludeSourceIds" : [ "3b551ccf5566478b9b77f37de25303aa" ],
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
} ],
"id" : "id12345",
"identityCount" : 42,
"technicalName" : "Technical Name",
"identityState" : "identityState",
"enabled" : true
"id" : "id12345"
}`) // LifecycleState | Lifecycle state to be created.
var lifecycleState v2025.LifecycleState
@@ -160,7 +168,7 @@ func main() {
## delete-lifecycle-state
Delete lifecycle state
Use this endpoint to delete the lifecycle state by its ID.
Use this endpoint to delete the lifecycle state by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-lifecycle-state)
@@ -229,7 +237,7 @@ func main() {
## get-lifecycle-state
Get lifecycle state
Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID.
Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-lifecycle-state)
@@ -467,7 +475,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption |
**jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority |
### Return type
@@ -495,7 +503,7 @@ import (
func main() {
identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID.
lifecycleStateId := `ef38f94347e94562b5bb8424a56397d8` // string | Lifecycle state ID. # string | Lifecycle state ID.
jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/accessProfileIds, value=[2c918087742bab150174407a80f3125e, 2c918087742bab150174407a80f3124f]}, {op=replace, path=/accountActions, value=[{action=ENABLE, sourceIds=[2c9180846a2f82fb016a481c1b1560c5, 2c9180846a2f82fb016a481c1b1560cc]}, {action=DISABLE, sourceIds=[2c91808869a0c9980169a207258513fb]}]}, {op=replace, path=/emailNotificationOption, value={notifyManagers=true, notifyAllAdmins=false, notifySpecificUsers=false, emailAddressList=[]}}]`) // []JsonPatchOperation | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/accessProfileIds, value=[2c918087742bab150174407a80f3125e, 2c918087742bab150174407a80f3124f]}, {op=replace, path=/accountActions, value=[{action=ENABLE, sourceIds=[2c9180846a2f82fb016a481c1b1560c5, 2c9180846a2f82fb016a481c1b1560cc], excludeSourceIds=null, allSources=false}, {action=DISABLE, sourceIds=null, excludeSourceIds=[3b551ccf5566478b9b77f37de25303aa], allSources=true}]}, {op=replace, path=/emailNotificationOption, value={notifyManagers=true, notifyAllAdmins=false, notifySpecificUsers=false, emailAddressList=[]}}, {op=replace, path=/accessActionConfiguration, value={removeAllAccessEnabled=true}}]`) // []JsonPatchOperation | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority
var jsonPatchOperation []v2025.JsonPatchOperation
if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil {

View File

@@ -0,0 +1,64 @@
---
id: v2025-access-action-configuration
title: AccessActionConfiguration
pagination_label: AccessActionConfiguration
sidebar_label: AccessActionConfiguration
sidebar_class_name: gosdk
keywords: ['go', 'Golang', 'sdk', 'AccessActionConfiguration', 'V2025AccessActionConfiguration']
slug: /tools/sdk/go/v2025/models/access-action-configuration
tags: ['SDK', 'Software Development Kit', 'AccessActionConfiguration', 'V2025AccessActionConfiguration']
---
# AccessActionConfiguration
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RemoveAllAccessEnabled** | Pointer to **bool** | If true, then all accesses are marked for removal. | [optional] [default to false]
## Methods
### NewAccessActionConfiguration
`func NewAccessActionConfiguration() *AccessActionConfiguration`
NewAccessActionConfiguration instantiates a new AccessActionConfiguration object
This constructor will assign default values to properties that have it defined,
and makes sure properties required by API are set, but the set of arguments
will change when the set of required properties is changed
### NewAccessActionConfigurationWithDefaults
`func NewAccessActionConfigurationWithDefaults() *AccessActionConfiguration`
NewAccessActionConfigurationWithDefaults instantiates a new AccessActionConfiguration object
This constructor will only assign default values to properties that have it defined,
but it doesn't guarantee that properties required by API are set
### GetRemoveAllAccessEnabled
`func (o *AccessActionConfiguration) GetRemoveAllAccessEnabled() bool`
GetRemoveAllAccessEnabled returns the RemoveAllAccessEnabled field if non-nil, zero value otherwise.
### GetRemoveAllAccessEnabledOk
`func (o *AccessActionConfiguration) GetRemoveAllAccessEnabledOk() (*bool, bool)`
GetRemoveAllAccessEnabledOk returns a tuple with the RemoveAllAccessEnabled field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRemoveAllAccessEnabled
`func (o *AccessActionConfiguration) SetRemoveAllAccessEnabled(v bool)`
SetRemoveAllAccessEnabled sets RemoveAllAccessEnabled field to given value.
### HasRemoveAllAccessEnabled
`func (o *AccessActionConfiguration) HasRemoveAllAccessEnabled() bool`
HasRemoveAllAccessEnabled returns a boolean if a field has been set.

View File

@@ -16,7 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountAction', 'V2025AccountAction']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Action** | Pointer to **string** | Describes if action will be enabled or disabled | [optional]
**SourceIds** | Pointer to **[]string** | List of unique source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features. | [optional]
**SourceIds** | Pointer to **[]string** | A unique list of specific source IDs to apply the action to. The sources must have the ENABLE feature or flat file source. Required if allSources is not true. Must not be provided if allSources is true. Cannot be used together with excludeSourceIds See \"/sources\" endpoint for source features. | [optional]
**ExcludeSourceIds** | Pointer to **[]string** | A list of source IDs to exclude from the action. Cannot be used together with sourceIds. | [optional]
**AllSources** | Pointer to **bool** | If true, the action applies to all available sources. If true, sourceIds must not be provided. If false or not set, sourceIds is required. | [optional] [default to false]
## Methods
@@ -87,4 +89,74 @@ SetSourceIds sets SourceIds field to given value.
HasSourceIds returns a boolean if a field has been set.
### SetSourceIdsNil
`func (o *AccountAction) SetSourceIdsNil(b bool)`
SetSourceIdsNil sets the value for SourceIds to be an explicit nil
### UnsetSourceIds
`func (o *AccountAction) UnsetSourceIds()`
UnsetSourceIds ensures that no value is present for SourceIds, not even an explicit nil
### GetExcludeSourceIds
`func (o *AccountAction) GetExcludeSourceIds() []string`
GetExcludeSourceIds returns the ExcludeSourceIds field if non-nil, zero value otherwise.
### GetExcludeSourceIdsOk
`func (o *AccountAction) GetExcludeSourceIdsOk() (*[]string, bool)`
GetExcludeSourceIdsOk returns a tuple with the ExcludeSourceIds field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetExcludeSourceIds
`func (o *AccountAction) SetExcludeSourceIds(v []string)`
SetExcludeSourceIds sets ExcludeSourceIds field to given value.
### HasExcludeSourceIds
`func (o *AccountAction) HasExcludeSourceIds() bool`
HasExcludeSourceIds returns a boolean if a field has been set.
### SetExcludeSourceIdsNil
`func (o *AccountAction) SetExcludeSourceIdsNil(b bool)`
SetExcludeSourceIdsNil sets the value for ExcludeSourceIds to be an explicit nil
### UnsetExcludeSourceIds
`func (o *AccountAction) UnsetExcludeSourceIds()`
UnsetExcludeSourceIds ensures that no value is present for ExcludeSourceIds, not even an explicit nil
### GetAllSources
`func (o *AccountAction) GetAllSources() bool`
GetAllSources returns the AllSources field if non-nil, zero value otherwise.
### GetAllSourcesOk
`func (o *AccountAction) GetAllSourcesOk() (*bool, bool)`
GetAllSourcesOk returns a tuple with the AllSources field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAllSources
`func (o *AccountAction) SetAllSources(v bool)`
SetAllSources sets AllSources field to given value.
### HasAllSources
`func (o *AccountAction) HasAllSources() bool`
HasAllSources returns a boolean if a field has been set.

View File

@@ -27,6 +27,8 @@ Name | Type | Description | Notes
**AccountActions** | Pointer to [**[]AccountAction**](account-action) | | [optional]
**AccessProfileIds** | Pointer to **[]string** | List of unique access-profile IDs that are associated with the lifecycle state. | [optional]
**IdentityState** | Pointer to **NullableString** | The lifecycle state's associated identity state. This field is generally 'null'. | [optional]
**AccessActionConfiguration** | Pointer to [**AccessActionConfiguration**](access-action-configuration) | | [optional]
**Priority** | Pointer to **NullableInt32** | Priority level used to determine which profile to assign when a user exists in multiple profiles. Lower numeric values have higher priority. By default, new profiles are assigned the lowest priority. The assigned profile also controls access granted or removed during provisioning based on lifecycle state changes. | [optional]
## Methods
@@ -367,4 +369,64 @@ HasIdentityState returns a boolean if a field has been set.
`func (o *LifecycleState) UnsetIdentityState()`
UnsetIdentityState ensures that no value is present for IdentityState, not even an explicit nil
### GetAccessActionConfiguration
`func (o *LifecycleState) GetAccessActionConfiguration() AccessActionConfiguration`
GetAccessActionConfiguration returns the AccessActionConfiguration field if non-nil, zero value otherwise.
### GetAccessActionConfigurationOk
`func (o *LifecycleState) GetAccessActionConfigurationOk() (*AccessActionConfiguration, bool)`
GetAccessActionConfigurationOk returns a tuple with the AccessActionConfiguration field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAccessActionConfiguration
`func (o *LifecycleState) SetAccessActionConfiguration(v AccessActionConfiguration)`
SetAccessActionConfiguration sets AccessActionConfiguration field to given value.
### HasAccessActionConfiguration
`func (o *LifecycleState) HasAccessActionConfiguration() bool`
HasAccessActionConfiguration returns a boolean if a field has been set.
### GetPriority
`func (o *LifecycleState) GetPriority() int32`
GetPriority returns the Priority field if non-nil, zero value otherwise.
### GetPriorityOk
`func (o *LifecycleState) GetPriorityOk() (*int32, bool)`
GetPriorityOk returns a tuple with the Priority field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPriority
`func (o *LifecycleState) SetPriority(v int32)`
SetPriority sets Priority field to given value.
### HasPriority
`func (o *LifecycleState) HasPriority() bool`
HasPriority returns a boolean if a field has been set.
### SetPriorityNil
`func (o *LifecycleState) SetPriorityNil(b bool)`
SetPriorityNil sets the value for Priority to be an explicit nil
### UnsetPriority
`func (o *LifecycleState) UnsetPriority()`
UnsetPriority ensures that no value is present for Priority, not even an explicit nil